fb-doc  0.4.0
FreeBASIC documentation tool
fbdoc_options.bi
Go to the documentation of this file.
1 
9 
10 #INCLUDE ONCE "dir.bi"
11 #INCLUDE ONCE "fbdoc_parser.bi"
12 
13 
14 
15 #DEFINE ERROUT(_T_) PRINT #OPT->Efnr, PROJ_NAME & ": " & _T_
16 
17 
18 #DEFINE MSG_LINE(_T_) PRINT #OPT->Efnr, NL; SPC(38 - LEN(_T_)); _T_; " -->";
19 
20 
21 #DEFINE MSG_CONT(_T_) PRINT #OPT->Efnr, " " & _T_;
22 
23 
24 #DEFINE MSG_END(_T_) PRINT #OPT->Efnr, _T_
25 
26 
27 
35 TYPE Options
36 
37  ENUM RunModes
38 
39 
44 
45 
50 
51 
55 
56 
61 
62 
65  DEF_MODE
66 
67 
74  FILE_MODE
75 
76 
83  LIST_MODE
84 
85 
94  SYNT_MODE
95 
96  END ENUM
97 
98 
103  ENUM TypesStyle
104  C_STYLE
105  FB_STYLE
106  END ENUM
107 
108 
109  ENUM CaseModes
110  CASE_ORIGN
111  CASE_LOWER
112  CASE_MIXED
113  CASE_UPPER
114  END ENUM
115 
118  AS Parser PTR Pars = 0
121  AS EmitterIF PTR EmitIF = 0
122  AS ANY PTR DllEmitter = 0
123 #IFDEF __FB_UNIX__
124 '&ZSTRING_PTR DirUp = "../"; //!< sequence to get one directory up
125 '&/* tricky declaration for Doxygen (it miss-interpretes the @ character)
126  AS ZSTRING PTR DirUp = @"../"
127 #ELSE
128  AS ZSTRING PTR DirUp = @"..\"
129 '&*/
130 #ENDIF
131  AS STRING _
132  InFiles = "" _
133  , StartPath = "" _
134  , FileIncl = "" _
135  , OutPath = "" _
136  , Errr = ""
137  AS INTEGER _
138  Asterix = 0 _
139  , Docom = 0 _
140  , AllCallees = 0 _
141  , InRecursiv = 0 _
142  , InTree = 0 _
143  , Level = 0 _
144  , Efnr = 0 _
145  , Ocha = 0
146  AS UBYTE _
147  JoComm = ASC("*") _
148  , AdLine = ASC("&")
149  AS EmitFunc _
150  CreateFunction _
151  , CreateVariable
152 
153  DECLARE CONSTRUCTOR()
154  DECLARE DESTRUCTOR()
155  DECLARE FUNCTION parseCLI() AS RunModes
156  DECLARE FUNCTION parseOptpara(BYREF Idx AS INTEGER) AS STRING
157  DECLARE FUNCTION chooseEmitter(BYREF F AS STRING, BYREF AS STRING) as EmitterIF PTR
158  DECLARE SUB FileModi()
159  DECLARE SUB doFile(BYREF AS STRING)
160  DECLARE FUNCTION checkDir(BYREF AS STRING) AS INTEGER
161  DECLARE FUNCTION scanFiles(BYREF AS STRING, BYREF AS STRING) AS STRING
162  DECLARE FUNCTION addPath(BYREF AS STRING, BYREF AS STRING) AS STRING
163 END TYPE
164 
165 
166 '&typedef Options* Options_PTR; //!< Doxygen internal (ignore this).
167 
168 COMMON SHARED AS Options PTR OPT
169 
170 ' Forward declaration of internal emitter init functions
171 DECLARE SUB init_csource(BYVAL AS EmitterIF PTR)
172 DECLARE SUB init_doxy(BYVAL AS EmitterIF PTR)
173 DECLARE SUB init_gtk(BYVAL AS EmitterIF PTR)
174 DECLARE SUB init_lfn(BYVAL AS EmitterIF PTR)
175 DECLARE SUB init_syntax(BYVAL AS EmitterIF PTR)
176