ab3f56f5ad18d7ca383fdce221cb85946be7ba51
[dragonfly.git] / usr.bin / mandoc / mdoc_strings.c
1 /*      $Id: mdoc_strings.c,v 1.10 2009/10/27 21:40:07 schwarze Exp $ */
2 /*
3  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 #include <sys/types.h>
18
19 #include <assert.h>
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <string.h>
23 #include <time.h>
24
25 #include "libmdoc.h"
26
27 /* FIXME: this file is poorly named. */
28
29 struct mdoc_secname {
30         const char      *name;  /* Name of section. */
31         enum mdoc_sec    sec;   /* Corresponding section. */
32 };
33
34 #define SECNAME_MAX     (20)
35
36 static  const struct mdoc_secname secnames[SECNAME_MAX] = {
37         { "NAME", SEC_NAME },
38         { "LIBRARY", SEC_LIBRARY },
39         { "SYNOPSIS", SEC_SYNOPSIS },
40         { "DESCRIPTION", SEC_DESCRIPTION },
41         { "IMPLEMENTATION NOTES", SEC_IMPLEMENTATION },
42         { "EXIT STATUS", SEC_EXIT_STATUS },
43         { "RETURN VALUES", SEC_RETURN_VALUES },
44         { "ENVIRONMENT", SEC_ENVIRONMENT },
45         { "FILES", SEC_FILES },
46         { "EXAMPLES", SEC_EXAMPLES },
47         { "DIAGNOSTICS", SEC_DIAGNOSTICS },
48         { "COMPATIBILITY", SEC_COMPATIBILITY },
49         { "ERRORS", SEC_ERRORS },
50         { "SEE ALSO", SEC_SEE_ALSO },
51         { "STANDARDS", SEC_STANDARDS },
52         { "HISTORY", SEC_HISTORY },
53         { "AUTHORS", SEC_AUTHORS },
54         { "CAVEATS", SEC_CAVEATS },
55         { "BUGS", SEC_BUGS },
56         { "SECURITY CONSIDERATIONS", SEC_SECURITY }
57 };
58
59
60 int
61 mdoc_iscdelim(char p)
62 {
63
64         switch (p) {
65         case('|'):
66                 /* FALLTHROUGH */
67         case('.'):
68                 /* FALLTHROUGH */
69         case(','):
70                 /* FALLTHROUGH */
71         case(';'):
72                 /* FALLTHROUGH */
73         case(':'):
74                 /* FALLTHROUGH */
75         case('?'):
76                 /* FALLTHROUGH */
77         case('!'):
78                 /* FALLTHROUGH */
79         case('('):
80                 /* FALLTHROUGH */
81         case(')'):
82                 /* FALLTHROUGH */
83         case('['):
84                 /* FALLTHROUGH */
85         case(']'):
86                 /* FALLTHROUGH */
87         case('{'):
88                 /* FALLTHROUGH */
89         case('}'):
90                 return(1);
91         default:
92                 break;
93         }
94
95         return(0);
96 }
97
98
99 int
100 mdoc_isdelim(const char *p)
101 {
102
103         if (0 == *p)
104                 return(0);
105         if (0 != *(p + 1))
106                 return(0);
107         return(mdoc_iscdelim(*p));
108 }
109
110
111 enum mdoc_sec
112 mdoc_atosec(const char *p)
113 {
114         int              i;
115
116         for (i = 0; i < SECNAME_MAX; i++)
117                 if (0 == strcmp(p, secnames[i].name))
118                         return(secnames[i].sec);
119
120         return(SEC_CUSTOM);
121 }
122
123
124 time_t
125 mdoc_atotime(const char *p)
126 {
127         struct tm        tm;
128         char            *pp;
129
130         bzero(&tm, sizeof(struct tm));
131
132         if (0 == strcmp(p, "$" "Mdocdate$"))
133                 return(time(NULL));
134         if ((pp = strptime(p, "$" "Mdocdate: %b %d %Y $", &tm)) && 0 == *pp)
135                 return(mktime(&tm));
136         /* XXX - this matches "June 1999", which is wrong. */
137         if ((pp = strptime(p, "%b %d %Y", &tm)) && 0 == *pp)
138                 return(mktime(&tm));
139         if ((pp = strptime(p, "%b %d, %Y", &tm)) && 0 == *pp)
140                 return(mktime(&tm));
141
142         return(0);
143 }
144
145
146 /* FIXME: move this into an editable .in file. */
147 size_t
148 mdoc_macro2len(int macro)
149 {
150
151         switch (macro) {
152         case(MDOC_Ad):
153                 return(12);
154         case(MDOC_Ao):
155                 return(12);
156         case(MDOC_An):
157                 return(12);
158         case(MDOC_Aq):
159                 return(12);
160         case(MDOC_Ar):
161                 return(12);
162         case(MDOC_Bo):
163                 return(12);
164         case(MDOC_Bq):
165                 return(12);
166         case(MDOC_Cd):
167                 return(12);
168         case(MDOC_Cm):
169                 return(10);
170         case(MDOC_Do):
171                 return(10);
172         case(MDOC_Dq):
173                 return(12);
174         case(MDOC_Dv):
175                 return(12);
176         case(MDOC_Eo):
177                 return(12);
178         case(MDOC_Em):
179                 return(10);
180         case(MDOC_Er):
181                 return(12);
182         case(MDOC_Ev):
183                 return(15);
184         case(MDOC_Fa):
185                 return(12);
186         case(MDOC_Fl):
187                 return(10);
188         case(MDOC_Fo):
189                 return(16);
190         case(MDOC_Fn):
191                 return(16);
192         case(MDOC_Ic):
193                 return(10);
194         case(MDOC_Li):
195                 return(16);
196         case(MDOC_Ms):
197                 return(6);
198         case(MDOC_Nm):
199                 return(10);
200         case(MDOC_No):
201                 return(12);
202         case(MDOC_Oo):
203                 return(10);
204         case(MDOC_Op):
205                 return(14);
206         case(MDOC_Pa):
207                 return(32);
208         case(MDOC_Pf):
209                 return(12);
210         case(MDOC_Po):
211                 return(12);
212         case(MDOC_Pq):
213                 return(12);
214         case(MDOC_Ql):
215                 return(16);
216         case(MDOC_Qo):
217                 return(12);
218         case(MDOC_So):
219                 return(12);
220         case(MDOC_Sq):
221                 return(12);
222         case(MDOC_Sy):
223                 return(6);
224         case(MDOC_Sx):
225                 return(16);
226         case(MDOC_Tn):
227                 return(10);
228         case(MDOC_Va):
229                 return(12);
230         case(MDOC_Vt):
231                 return(12);
232         case(MDOC_Xr):
233                 return(10);
234         default:
235                 break;
236         };
237         return(0);
238 }