lenses/debctrl.aug

   1 (*
   2 Module: debctrl
   3   Parses ./debian/control
   4
   5 Author:
   6         Dominique Dumont domi.dumont@free.fr or dominique.dumont@hp.com
   7
   8 About: Reference
   9   http://augeas.net/page/Create_a_lens_from_bottom_to_top
  10   http://www.debian.org/doc/debian-policy/ch-controlfields.html
  11
  12 About: License
  13   This file is licensed under the LGPL v2+.
  14
  15 About: Lens Usage
  16   Since control file is not a system configuration file, you will have
  17   to use augtool -r option to point to 'debian' directory.
  18
  19   Run augtool:
  20   $ augtool -r debian
  21
  22   Sample usage of this lens in augtool:
  23
  24     * Get the value stored in control file
  25       > print /files/control
  26       ...
  27
  28   Saving your file:
  29
  30       > save
  31
  32
  33 *)
  34
  35 module Debctrl =
  36   autoload xfm
  37
  38 let eol = Util.eol
  39 let del_ws_spc = del /[\t ]*/ " "
  40 let hardeol = del /\n/ "\n"
  41 let del_opt_ws = del /[\t ]*/ ""
  42 let colon = del /:[ \t]*/ ": "
  43
  44 let simple_entry (k:regexp) =
  45    let value =  store /[^ \t][^\n]+/ in
  46    [ key k . colon . value . hardeol ]
  47
  48 let cont_line = del /\n[ \t]+/ "\n "
  49 let comma     = del  /,[ \t]*/  ", "
  50
  51 let sep_comma_with_nl = del /[ \t\n]*,[ \t\n]*/ ",\n "
  52  (*= del_opt_ws . cont_line* . comma . cont_line**)
  53
  54 let email =  store ( /([A-Za-z]+ )+<[^\n>]+>/ |  /[^\n,\t<> ]+/ )
  55
  56 let multi_line_array_entry (k:regexp) (v:lens) =
  57     [ key k . colon . [ counter "array" . seq "array" .  v ] .
  58       [ seq "array" . sep_comma_with_nl . v ]* . hardeol ]
  59
  60 (* dependency stuff *)
  61
  62 let version_depends =
  63     [ label "version"
  64      . [   del / *\( */ " ( " . label "relation" . store /[<>=]+/ ]
  65      . [   del_ws_spc . label "number"
  66            . store ( /[a-zA-Z0-9_.-]+/ | /\$\{[a-zA-Z0-9:]+\}/ )
  67          . del / *\)/ " )" ]
  68     ]
  69
  70 let arch_depends =
  71     [ label "arch"
  72     . [  del / *\[ */ " [ " . label "prefix" . store /!?/ ]
  73     . [ label "name" . store /[a-zA-Z0-9_.-]+/ . del / *\]/ " ]" ] ]
  74
  75
  76 let package_depends
  77   =  [ key ( /[a-zA-Z0-9_-]+/ | /\$\{[a-zA-Z0-9:]+\}/ )
  78         . ( version_depends | arch_depends ) * ]
  79
  80
  81 let dependency = [ label "or" . package_depends ]
  82                . [ label "or" . del / *\| */ " | "
  83                    . package_depends ] *
  84
  85 let dependency_list (field:regexp) =
  86     [ key field . colon . [ label "and" .  dependency ]
  87       . [ label "and" . sep_comma_with_nl . dependency ]*
  88       . eol ]
  89
  90 (* source package *)
  91 let uploaders  =
  92     multi_line_array_entry /Uploaders/ email
  93
  94 let simple_src_keyword = "Source" | "Section" | "Priority"
  95     | "Standards\-Version" | "Homepage" | /Vcs\-Svn/ | /Vcs\-Browser/
  96     | "Maintainer" | "DM-Upload-Allowed" | /XS?-Python-Version/
  97 let depend_src_keywords = /Build\-Depends/ | /Build\-Depends\-Indep/
  98
  99 let src_entries = (   simple_entry simple_src_keyword
 100                     | uploaders
 101                     | dependency_list depend_src_keywords ) *
 102
 103
 104 (* package paragraph *)
 105 let multi_line_entry (k:string) =
 106      let line = /.*[^ \t\n].*/ in
 107       [ label k .  del / / " " .  store line . hardeol ] *
 108
 109
 110 let description
 111   = [ key "Description" . colon
 112      . [ label "summary" . store /[a-zA-Z][^\n]+/ . hardeol ]
 113      . multi_line_entry "text" ]
 114
 115
 116 (* binary package *)
 117 let simple_bin_keywords = "Package" | "Architecture" |  "Section"
 118     | "Priority" | "Essential" | "Homepage" | "XB-Python-Version"
 119 let depend_bin_keywords = "Depends" | "Recommends" | "Suggests" | "Provides"
 120
 121 let bin_entries = ( simple_entry simple_bin_keywords
 122                   | dependency_list depend_bin_keywords
 123                   ) + . description
 124
 125 (* The whole stuff *)
 126 let lns =  [ label "srcpkg" .  src_entries  ]
 127         .  [ label "binpkg" . hardeol+ . bin_entries ]+
 128         . eol*
 129
 130 (* lens must be used with AUG_ROOT set to debian package source directory *)
 131 let xfm = transform lns (incl "/control")