PageRenderTime 58ms CodeModel.GetById 30ms RepoModel.GetById 0ms app.codeStats 0ms

/archivers/libarchive/files/doc/mdoc2wiki.awk

https://github.com/jsonn/pkgsrc
AWK | 488 lines | 434 code | 18 blank | 36 comment | 0 complexity | 080dc56b899dee83dd105db013da8dbe MD5 | raw file
    

  1. #!/usr/bin/awk
    2. 

  2. #
    3. 

  3. # Copyright (c) 2003 Peter Stuge <stuge-mdoc2man@cdy.org>
    4. 

  4. #
    5. 

  5. # Permission to use, copy, modify, and distribute this software for any
    6. 

  6. # purpose with or without fee is hereby granted, provided that the above
    7. 

  7. # copyright notice and this permission notice appear in all copies.
    8. 

  8. #
    9. 

  9. # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    10. 

  10. # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
    11. 

  11. # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    12. 

  12. # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    13. 

  13. # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
    14. 

  14. # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    15. 

  15. # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
    16. 

  16. 

  17. # Dramatically overhauled by Tim Kientzle.  This version almost
    18. 

  18. # handles library-style pages with Fn, Ft, etc commands.  Still
    19. 

  19. # a lot of problems...
    20. 

  20. 

  21. BEGIN {
    22. 

  22.   displaylines = 0
    23. 

  23.   listdepth = 0
    24. 

  24.   trailer = ""
    25. 

  25.   out = ""
    26. 

  26.   sep = ""
    27. 

  27.   nextsep = " "
    28. 

  28.   spaces = "                    "
    29. 

  29. 

  30.   NORMAL_STATE = 0
    31. 

  31.   PRETAG_STATE = 1
    32. 

  32.   STATE = NORMAL_STATE
    33. 

  33. }
    34. 

  34. 

  35. # Add a word with appropriate preceding whitespace
    36. 

  36. # Maintain a short queue of the expected upcoming word separators.
    37. 

  37. function add(str) {
    38. 

  38.   out=out sep str
    39. 

  39.   sep = nextsep
    40. 

  40.   nextsep = " "
    41. 

  41. }
    42. 

  42. 

  43. # Add a word with no following whitespace
    44. 

  44. # Use for opening punctuation such as '('
    45. 

  45. function addopen(str) {
    46. 

  46.   add(str)
    47. 

  47.   sep = ""
    48. 

  48. }
    49. 

  49. 

  50. # Add a word with no preceding whitespace
    51. 

  51. # Use for closing punctuation such as ')' or '.'
    52. 

  52. function addclose(str) {
    53. 

  53.   sep = ""
    54. 

  54.   add(str)
    55. 

  55. }
    56. 

  56. 

  57. # Add a word with no space before or after
    58. 

  58. # Use for separating punctuation such as '='
    59. 

  59. function addpunct(str) {
    60. 

  60.   sep = ""
    61. 

  61.   add(str)
    62. 

  62.   sep = ""
    63. 

  63. }
    64. 

  64. 

  65. # Emit the current line so far
    66. 

  66. function endline() {
    67. 

  67.   addclose(trailer)
    68. 

  68.   trailer = ""
    69. 

  69.   if(length(out) > 0) {
    70. 

  70.     if (STATE == PRETAG_STATE) {
    71. 

  71.       print out
    72. 

  72.     } else {
    73. 

  73.       print out " "
    74. 

  74.     }
    75. 

  75.     out=""
    76. 

  76.   }
    77. 

  77.   if(displaylines > 0) {
    78. 

  78.     displaylines = displaylines - 1
    79. 

  79.     if (displaylines == 0)
    80. 

  80.       dispend()
    81. 

  81.   }
    82. 

  82.   # First word on next line has no preceding whitespace
    83. 

  83.   sep = ""
    84. 

  84. }
    85. 

  85. 

  86. function linecmd(cmd) {
    87. 

  87.   endline()
    88. 

  88.   add(cmd)
    89. 

  89.   endline()
    90. 

  90. }
    91. 

  91. 

  92. function breakline() {
    93. 

  93.   linecmd("<br>")
    94. 

  94. }
    95. 

  95. 

  96. function crossref(name, sect, other) {
    97. 

  97.   if (name == "cpio" && sect == 1) {
    98. 

  98.     n = "ManPageBsdcpio1"
    99. 

  99.   } else if (name == "cpio" && sect == 5) {
    100. 

  100.     n = "ManPageCpio5"
    101. 

  101.   } else if (name == "mtree" && sect == 5) {
    102. 

  102.     n = "ManPageMtree5"
    103. 

  103.   } else if (name == "tar" && sect == 1) {
    104. 

  104.     n = "ManPageBsdtar1"
    105. 

  105.   } else if (name == "tar" && sect == 5) {
    106. 

  106.     n = "ManPageTar5"
    107. 

  107.   } else if (!match(name, "^archive") && !match(name, "^libarchive")) {
    108. 

  108.     n = name "(" sect ")|http://www.freebsd.org/cgi/man.cgi?query=" name "&sektion=" sect
    109. 

  109.   } else {
    110. 

  110.     n = "ManPage"
    111. 

  111.     numbits = split(name, namebits, "[_-]")
    112. 

  112.     for (i = 1; i <= numbits; ++i) {
    113. 

  113.       p = namebits[i]
    114. 

  114.       n = n toupper(substr(p, 0, 1)) substr(p, 2)
    115. 

  115.     }
    116. 

  116.     n = n sect
    117. 

  117.   }
    118. 

  118.   n = "[[" n "]]"
    119. 

  119.   if (length other > 0)
    120. 

  120.     n = n other
    121. 

  121.   return n
    122. 

  122. }
    123. 

  123. 

  124. # Start an indented display
    125. 

  125. function dispstart() {
    126. 

  126.   endline()
    127. 

  127.   print "```text"
    128. 

  128. }
    129. 

  129. 

  130. # End an indented display
    131. 

  131. function dispend() {
    132. 

  132.   endline()
    133. 

  133.   print "```"
    134. 

  134. }
    135. 

  135. 

  136. # Collect rest of input line
    137. 

  137. function wtail() {
    138. 

  138.   retval=""
    139. 

  139.   while(w<nwords) {
    140. 

  140.     if(length(retval))
    141. 

  141.       retval=retval " "
    142. 

  142.     retval=retval words[++w]
    143. 

  143.   }
    144. 

  144.   return retval
    145. 

  145. }
    146. 

  146. 

  147. function splitwords(l, dest, n, o, w) {
    148. 

  148.   n = 1
    149. 

  149.   delete dest
    150. 

  150.   while (length(l) > 0) {
    151. 

  151.     sub("^[ \t]*", "", l)
    152. 

  152.     if (match(l, "^\"")) {
    153. 

  153.       l = substr(l, 2)
    154. 

  154.       o = index(l, "\"")
    155. 

  155.       if (o > 0) {
    156. 

  156.         w = substr(l, 1, o-1)
    157. 

  157.         l = substr(l, o+1)
    158. 

  158.         dest[n++] = w
    159. 

  159.       } else {
    160. 

  160.         dest[n++] = l
    161. 

  161.         l = ""
    162. 

  162.       }
    163. 

  163.     } else {
    164. 

  164.       o = match(l, "[ \t]")
    165. 

  165.       if (o > 0) {
    166. 

  166.         w = substr(l, 1, o-1)
    167. 

  167.         l = substr(l, o+1)
    168. 

  168.         dest[n++] = w
    169. 

  169.       } else {
    170. 

  170.         dest[n++] = l
    171. 

  171.         l = ""
    172. 

  172.       }
    173. 

  173.     }
    174. 

  174.   }
    175. 

  175.   return n-1
    176. 

  176. }
    177. 

  177. 

  178. ! /^\./ {
    179. 

  179.   out = $0
    180. 

  180.   endline()
    181. 

  181.   next
    182. 

  182. }
    183. 

  183. 

  184. /^\.\\"/ { next }
    185. 

    186. 

  186. {
    187. 

  187.   gsub("\\\\e", "\\")
    188. 

  188.   sub("^\\.","")
    189. 

  189.   nwords=splitwords($0, words)
    190. 

  190.   # TODO: Instead of iterating 'w' over the array, have a separate
    191. 

  191.   # function that returns 'next word' and use that.  This will allow
    192. 

  192.   # proper handling of double-quoted arguments as well.
    193. 

  193.   for(w=1;w<=nwords;w++) {
    194. 

  194.     if(match(words[w],"^Li$")) { # Literal; rest of line is unformatted
    195. 

  195.       dispstart()
    196. 

  196.       displaylines = 1
    197. 

  197.     } else if(match(words[w],"^Dl$")) { # Display literal
    198. 

  198.       dispstart()
    199. 

  199.       displaylines = 1
    200. 

  200.     } else if(match(words[w],"^Bd$")) { # Begin display
    201. 

  201.       STATE = PRETAG_STATE
    202. 

  202.       if(match(words[w+1],"-literal")) {
    203. 

  203.         dispstart()
    204. 

  204.         displaylines=10000
    205. 

  205.         w=nwords
    206. 

  206.       }
    207. 

  207.     } else if(match(words[w],"^Ed$")) { # End display
    208. 

  208.       displaylines = 0
    209. 

  209.       dispend()
    210. 

  210.       STATE = NORMAL_STATE
    211. 

  211.     } else if(match(words[w],"^Ns$")) { # Suppress space before next word
    212. 

  212.       sep=""
    213. 

  213.     } else if(match(words[w],"^No$")) { # Normal text
    214. 

  214.       add(words[++w])
    215. 

  215.     } else if(match(words[w],"^Dq$")) { # Quote
    216. 

  216.       addopen("\"")
    217. 

  217.       add(words[++w])
    218. 

  218.       while(w<nwords&&!match(words[w+1],"^[\\.,]"))
    219. 

  219.         add(words[++w])
    220. 

  220.       addclose("\"")
    221. 

  221.     } else if(match(words[w],"^Do$")) {
    222. 

  222.       addopen("\"")
    223. 

  223.     } else if(match(words[w],"^Dc$")) {
    224. 

  224.       addclose("\"")
    225. 

  225.     } else if(match(words[w],"^Oo$")) {
    226. 

  226.       addopen("<nowiki>[</nowiki>")
    227. 

  227.     } else if(match(words[w],"^Oc$")) {
    228. 

  228.       addclose("<nowiki>]</nowiki>")
    229. 

  229.     } else if(match(words[w],"^Ao$")) {
    230. 

  230.       addopen("&lt;")
    231. 

  231.     } else if(match(words[w],"^Ac$")) {
    232. 

  232.       addclose("&gt;")
    233. 

  233.     } else if(match(words[w],"^Dd$")) {
    234. 

  234.       date=wtail()
    235. 

  235.       next
    236. 

  236.     } else if(match(words[w],"^Dt$")) {
    237. 

  237.       id=words[++w] "(" words[++w] ")"
    238. 

  238.       next
    239. 

  239.     } else if(match(words[w],"^Ox$")) {
    240. 

  240.       add("OpenBSD")
    241. 

  241.     } else if(match(words[w],"^Fx$")) {
    242. 

  242.       add("FreeBSD")
    243. 

  243.     } else if(match(words[w],"^Bx$")) {
    244. 

  244.       add("BSD")
    245. 

  245.     } else if(match(words[w],"^Nx$")) {
    246. 

  246.       add("NetBSD")
    247. 

  247.     } else if(match(words[w],"^St$")) {
    248. 

  248.       if (match(words[w+1], "^-p1003.1$")) {
    249. 

  249.          w++
    250. 

  250.          add("<nowiki>IEEE Std 1003.1 (``POSIX.1'')</nowiki>")
    251. 

  251.       } else if(match(words[w+1], "^-p1003.1-96$")) {
    252. 

  252.          w++
    253. 

  253.          add("<nowiki>ISO/IEC 9945-1:1996 (``POSIX.1'')</nowiki>")
    254. 

  254.       } else if(match(words[w+1], "^-p1003.1-88$")) {
    255. 

  255.          w++
    256. 

  256.          add("<nowiki>IEEE Std 1003.1-1988 (``POSIX.1'')</nowiki>")
    257. 

  257.       } else if(match(words[w+1], "^-p1003.1-2001$")) {
    258. 

  258.          w++
    259. 

  259.          add("<nowiki>IEEE Std 1003.1-2001 (``POSIX.1'')</nowiki>")
    260. 

  260.       } else if(match(words[w+1], "^-susv2$")) {
    261. 

  261.          w++
    262. 

  262.          add("<nowiki>Version 2 of the Single UNIX Specification (``SUSv2'')</nowiki>")
    263. 

  263.       }
    264. 

  264.     } else if(match(words[w],"^Ex$")) {
    265. 

  265.       if (match(words[w+1], "^-std$")) {
    266. 

  266.          w++
    267. 

  267.          add("The '''" name "''' utility exits 0 on success, and &gt;0 if an error occurs.")
    268. 

  268.       }
    269. 

  269.     } else if(match(words[w],"^Os$")) {
    270. 

  270.       add(id " manual page")
    271. 

  271.     } else if(match(words[w],"^Sh$")) {
    272. 

  272.       section=wtail()
    273. 

  273.       linecmd("== " section " ==")
    274. 

  274.     } else if(match(words[w],"^Xr$")) {
    275. 

  275.       add(crossref(words[w+1], words[w+2], words[w+3]))
    276. 

  276.       w = w + 3
    277. 

  277.     } else if(match(words[w],"^Nm$")) {
    278. 

  278.       if(match(section,"SYNOPSIS"))
    279. 

  279.         breakline()
    280. 

  280.       if(w >= nwords)
    281. 

  281.         n=name
    282. 

  282.       else if (match(words[w+1], "^[A-Z][a-z]$"))
    283. 

  283.         n=name
    284. 

  284.       else if (match(words[w+1], "^[.,;:]$"))
    285. 

  285.         n=name
    286. 

  286.       else {
    287. 

  287.         n=words[++w]
    288. 

  288.         if(!length(name))
    289. 

  289.           name=n
    290. 

  290.       }
    291. 

  291.       if(!length(n))
    292. 

  292.         n=name
    293. 

  293.       if (displaylines == 0)
    294. 

  294.         add("'''" n "'''")
    295. 

  295.       else
    296. 

  296.         add(n)
    297. 

  297.     } else if(match(words[w],"^Nd$")) {
    298. 

  298.       add("- " wtail())
    299. 

  299.     } else if(match(words[w],"^Fl$")) {
    300. 

  300.       addopen("-")
    301. 

  301.     } else if(match(words[w],"^Ar$")) {
    302. 

  302.       if(w==nwords)
    303. 

  303.         add("''file ...''")
    304. 

  304.       else {
    305. 

  305.         ++w
    306. 

  306.         gsub("<", "\\&lt;", words[w])
    307. 

  307.         if (displaylines > 0)
    308. 

  308.           add(words[w])
    309. 

  309.         else
    310. 

  310.           add("''" words[w] "''")
    311. 

  311.       }
    312. 

  312.     } else if(match(words[w],"^Cm$")) {
    313. 

  313.       ++w
    314. 

  314.       if (displaylines == 0) {
    315. 

  315.         add("'''" words[w] "'''")
    316. 

  316.       } else
    317. 

  317.         add(words[w])
    318. 

  318.     } else if(match(words[w],"^Op$")) {
    319. 

  319.       addopen("<nowiki>[</nowiki>")
    320. 

  320.       option=1
    321. 

  321.       trailer="<nowiki>]</nowiki>" trailer
    322. 

  322.     } else if(match(words[w],"^Pp$")) {
    323. 

  323.       ++w
    324. 

  324.       endline()
    325. 

  325.       print ""
    326. 

  326.     } else if(match(words[w],"^An$")) {
    327. 

  327.       if (match(words[w+1],"-nosplit"))
    328. 

  328.         ++w
    329. 

  329.       endline()
    330. 

  330.     } else if(match(words[w],"^Ss$")) {
    331. 

  331.       add("===")
    332. 

  332.       trailer="==="
    333. 

  333.     } else if(match(words[w],"^Ft$")) {
    334. 

  334.       if (match(section, "SYNOPSIS")) {
    335. 

  335.         breakline()
    336. 

  336.       }
    337. 

  337.       l = wtail()
    338. 

  338.       add("''" l "''")
    339. 

  339.       if (match(section, "SYNOPSIS")) {
    340. 

  340.         breakline()
    341. 

  341.       }
    342. 

  342.     } else if(match(words[w],"^Fn$")) {
    343. 

  343.       ++w
    344. 

  344.       F = "'''" words[w] "'''("
    345. 

  345.       Fsep = ""
    346. 

  346.       while(w<nwords) {
    347. 

  347.         ++w
    348. 

  348.         if (match(words[w], "^[.,:]$")) {
    349. 

  349.           --w
    350. 

  350.           break
    351. 

  351.         }
    352. 

  352.         F = F Fsep "''"  words[w] "''"
    353. 

  353.         Fsep = ", "
    354. 

  354.       }
    355. 

  355.       add(F ")")
    356. 

  356.       if (match(section, "SYNOPSIS")) {
    357. 

  357.         addclose(";")
    358. 

  358.       }
    359. 

  359.     } else if(match(words[w],"^Fo$")) {
    360. 

  360.       w++
    361. 

  361.       F = "'''" words[w] "'''("
    362. 

  362.       Fsep = ""
    363. 

  363.     } else if(match(words[w],"^Fa$")) {
    364. 

  364.       w++
    365. 

  365.       F = F Fsep "''"  words[w] "''"
    366. 

  366.       Fsep = ", "
    367. 

  367.     } else if(match(words[w],"^Fc$")) {
    368. 

  368.       add(F ")")
    369. 

  369.       if (match(section, "SYNOPSIS")) {
    370. 

  370.         addclose(";")
    371. 

  371.       }
    372. 

  372.     } else if(match(words[w],"^Va$")) {
    373. 

  373.       w++
    374. 

  374.       add("''" words[w] "''")
    375. 

  375.     } else if(match(words[w],"^In$")) {
    376. 

  376.       w++
    377. 

  377.       add("'''<nowiki>#include <" words[w] "></nowiki>'''")
    378. 

  378.     } else if(match(words[w],"^Pa$")) {
    379. 

  379.       w++
    380. 

  380. #      if(match(words[w],"^\\."))
    381. 

  381. #       add("\\&")
    382. 

  382.       if (displaylines == 0)
    383. 

  383.         add("''" words[w] "''")
    384. 

  384.       else
    385. 

  385.         add(words[w])
    386. 

  386.     } else if(match(words[w],"^Dv$")) {
    387. 

  387.       linecmd()
    388. 

  388.     } else if(match(words[w],"^Em|Ev$")) {
    389. 

  389.       add(".IR")
    390. 

  390.     } else if(match(words[w],"^Pq$")) {
    391. 

  391.       addopen("(")
    392. 

  392.       trailer=")" trailer
    393. 

  393.     } else if(match(words[w],"^Aq$")) {
    394. 

  394.       addopen(" &lt;")
    395. 

  395.       trailer="&gt;" trailer
    396. 

  396.     } else if(match(words[w],"^Brq$")) {
    397. 

  397.       addopen("<nowiki>{</nowiki>")
    398. 

  398.       trailer="<nowiki>}</nowiki>" trailer
    399. 

  399.     } else if(match(words[w],"^S[xy]$")) {
    400. 

  400.       add(".B " wtail())
    401. 

  401.     } else if(match(words[w],"^Tn$")) {
    402. 

  402.       n=wtail()
    403. 

  403.       add("'''" n "'''")
    404. 

  404.     } else if(match(words[w],"^Ic$")) {
    405. 

  405.       add("''")
    406. 

  406.       trailer="''" trailer
    407. 

  407.     } else if(match(words[w],"^Bl$")) {
    408. 

  408.       ++listdepth
    409. 

  409.       listnext[listdepth]=""
    410. 

  410.       if(match(words[w+1],"-bullet")) {
    411. 

  411.         optlist[listdepth]=1
    412. 

  412.         addopen("<ul>")
    413. 

  413.         listclose[listdepth]="</ul>"
    414. 

  414.       } else if(match(words[w+1],"-enum")) {
    415. 

  415.         optlist[listdepth]=2
    416. 

  416.         enum=0
    417. 

  417.         addopen("<ol>")
    418. 

  418.         listclose[listdepth]="</ol>"
    419. 

  419.       } else if(match(words[w+1],"-tag")) {
    420. 

  420.         optlist[listdepth]=3
    421. 

  421.         addopen("<dl>")
    422. 

  422.         listclose[listdepth]="</dl>"
    423. 

  423.       } else if(match(words[w+1],"-item")) {
    424. 

  424.         optlist[listdepth]=4
    425. 

  425.         addopen("<ul>")
    426. 

  426.         listclose[listdepth]="</ul>"
    427. 

  427.       }
    428. 

  428.       w=nwords
    429. 

  429.     } else if(match(words[w],"^El$")) {
    430. 

  430.       addclose(listnext[listdepth])
    431. 

  431.       addclose(listclose[listdepth])
    432. 

  432.       listclose[listdepth]=""
    433. 

  433.       listdepth--
    434. 

  434.     } else if(match(words[w],"^It$")) {
    435. 

  435.       addclose(listnext[listdepth])
    436. 

  436.       if(optlist[listdepth]==1) {
    437. 

  437.         addpunct("<li>")
    438. 

  438.         listnext[listdepth] = "</li>"
    439. 

  439.       } else if(optlist[listdepth]==2) {
    440. 

  440.         addpunct("<li>")
    441. 

  441.         listnext[listdepth] = "</li>"
    442. 

  442.       } else if(optlist[listdepth]==3) {
    443. 

  443.         addpunct("<dt>")
    444. 

  444.         listnext[listdepth] = "</dt>"
    445. 

  445.         if(match(words[w+1],"^Xo$")) {
    446. 

  446.           # Suppress trailer
    447. 

  447.           w++
    448. 

  448.         } else if(match(words[w+1],"^Pa$|^Ev$")) {
    449. 

  449.           addopen("'''")
    450. 

  450.           w++
    451. 

  451.           add(words[++w] "'''")
    452. 

  452.           trailer = listnext[listdepth] "<dd>" trailer
    453. 

  453.           listnext[listdepth] = "</dd>"
    454. 

  454.         } else {
    455. 

  455.           trailer = listnext[listdepth] "<dd>" trailer
    456. 

  456.           listnext[listdepth] = "</dd>"
    457. 

  457.         }
    458. 

  458.       } else if(optlist[listdepth]==4) {
    459. 

  459.         addpunct("<li>")
    460. 

  460.         listnext[listdepth] = "</li>"
    461. 

  461.       }
    462. 

  462.     } else if(match(words[w], "^Vt$")) {
    463. 

  463.       w++
    464. 

  464.       add("''" words[w] "''")
    465. 

  465.     } else if(match(words[w],"^Xo$")) {
    466. 

  466.       # TODO: Figure out how to handle this
    467. 

  467.     } else if(match(words[w],"^Xc$")) {
    468. 

  468.       # TODO: Figure out how to handle this
    469. 

  469.       if (optlist[listdepth] == 3) {
    470. 

  470.         addclose(listnext[listdepth])
    471. 

  471.         addopen("<dd>")
    472. 

  472.         listnext[listdepth] = "</dd>"
    473. 

  473.       }
    474. 

  474.     } else if(match(words[w],"^[=]$")) {
    475. 

  475.       addpunct(words[w])
    476. 

  476.     } else if(match(words[w],"^[[{(]$")) {
    477. 

  477.       addopen(words[w])
    478. 

  478.     } else if(match(words[w],"^[\\])}.,;:]$")) {
    479. 

  479.       addclose(words[w])
    480. 

  480.     } else {
    481. 

  481.       sub("\\\\&", "", words[w])
    482. 

  482.       add(words[w])
    483. 

  483.     }
    484. 

  484.   }
    485. 

  485.   if(match(out,"^\\.[^a-zA-Z]"))
    486. 

  486.     sub("^\\.","",out)
    487. 

  487.   endline()
    488. 

  488. }
    489. 

  489.