summaryrefslogtreecommitdiffstats
path: root/autodoc/source/exes/adc_uni/adc_cmds.hxx
blob: 210602ffeffddad0d27c738e2ee2f37c52240ce3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
/*************************************************************************
 *
 *  $RCSfile: adc_cmds.hxx,v $
 *
 *  $Revision: 1.1.1.1 $
 *
 *  last change: $Author: np $ $Date: 2002-03-08 14:45:27 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef ADC_ADC_CMDS_HXX
#define ADC_ADC_CMDS_HXX



// USED SERVICES
    // BASE CLASSES
#include <cosv/comdline.hxx>
    // COMPONENTS
#include <cosv/ploc.hxx>
    // PARAMETERS

namespace ary
{
    class Repository;
}

namespace autodoc
{
    class CommandLine;

namespace command
{


class Command
{
  public:
    virtual             ~Command() {}

    /** @return The first not parsed argument.
        If an error occured, 0 is returned.
    */
    char * *            Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
  private:
    virtual char * *    do_Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs ) = 0;
};

inline char * *
Command::Init( char * *            i_nCurArgsBegin,
               char * *            i_nEndOfAllArgs )
    { return do_Init(i_nCurArgsBegin, i_nEndOfAllArgs); }


struct S_ProjectData;
struct S_LanguageInfo;
struct S_ExternLinkage;

class Parse : public Command
{
  public:
    typedef std::vector< DYN S_ProjectData * >  ProjectList;
    typedef ProjectList::const_iterator         ProjectIterator;

                        Parse(
                            CommandLine &       io_rCommandLine );
                        ~Parse();

    // INQUIRY
    const udmstri &     ReposyName() const;
    const S_LanguageInfo *
                        GlobalLanguageInfo() const;
    bool                GlobalIsHtmlDefaultForDocs() const;
    ProjectIterator     ProjectsBegin() const;
    ProjectIterator     ProjectsEnd() const;


    // ACCESS
    S_ProjectData &     CreateDefaultProject();

  private:
    // Interface Command:
    virtual char * *    do_Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );

    typedef char * * (Parse::*F_Init)(char * *, char * *);
    typedef std::map< udmstri , F_Init >    InitMap;

    static const InitMap &
                        Options();
    F_Init              FindFI(
                            const char *        i_pArg ) const;

    char * *            FI_Start_ParseOptions(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetName(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetUpdate(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetLanguage4All(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetExtensions4All(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetDocAttrs4All(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );

    char * *            FI_Start_ProjectOptions(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetLanguage(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetExtensions(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetDocAttrs(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetSourceDirs(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetSourceTrees(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    char * *            FI_SetSourceFiles(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );

    // DATA
    udmstri             sRepositoryName;
    udmstri             sRepositoryDirectoryForUpdate;

    Dyn<S_LanguageInfo> pGlobal_Language;
    bool                bGlobal_HtmlIsDefaultForDocs;

    ProjectList         aProjects;

    CommandLine *       pCommandLine;
    static InitMap      aOptions_;
};

inline const udmstri &
Parse::ReposyName() const
    { return sRepositoryName; }
inline const S_LanguageInfo *
Parse::GlobalLanguageInfo() const
    { return pGlobal_Language ? pGlobal_Language.Ptr() : 0; }
inline bool
Parse::GlobalIsHtmlDefaultForDocs() const
    { return bGlobal_HtmlIsDefaultForDocs; }
inline Parse::ProjectIterator
Parse::ProjectsBegin() const
    { return aProjects.begin(); }
inline Parse::ProjectIterator
Parse::ProjectsEnd() const
    { return aProjects.end(); }

class Load : public Command
{
  public:
                        Load(
                            const char *        i_sRepositoryDirectory = "" );
                        ~Load();

    const udmstri &     ReposyDir() const;

  private:
    // Interface Command:
    virtual char * *    do_Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    // DATA
    udmstri             sRepositoryDirectory;
};

inline const udmstri &
Load::ReposyDir() const
    { return sRepositoryDirectory; }

struct S_ExternLinkage
{
                        S_ExternLinkage(
                            const char *        i_sNamespace,
                            const char *        i_sLinkedRootDirectory )
                            :   sNamespace(i_sNamespace),
                                sLinkedRootDirectory(i_sLinkedRootDirectory)
                            { }

    udmstri             sNamespace;
    udmstri             sLinkedRootDirectory;

};

class CreateHtml : public Command
{
  public:
                        CreateHtml();
                        ~CreateHtml();

    const udmstri &     OutputDir() const;

  private:
    // Interface Command:
    virtual char * *    do_Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    // DATA
    udmstri             sOutputRootDirectory;

    std::vector< S_ExternLinkage >
                        aExtLinks;
};

inline const udmstri &
CreateHtml::OutputDir() const
    { return sOutputRootDirectory; }


class CreateXml : public Command
{
  public:
                        CreateXml();
                        ~CreateXml();

    const udmstri &     OutputDir() const;

  private:
    // Interface Command:
    virtual char * *    do_Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    // DATA
    udmstri             sOutputRootDirectory;
};

inline const udmstri &
CreateXml::OutputDir() const
    { return sOutputRootDirectory; }



class Save : public Command
{
  public:
                        Save();
                        ~Save();

    const udmstri &     ReposyDir() const;

  private:
    // Interface Command:
    virtual char * *    do_Init(
                            char * *            i_nCurArgsBegin,
                            char * *            i_nEndOfAllArgs );
    // DATA
    udmstri             sRepositoryDirectory;
};

inline const udmstri &
Save::ReposyDir() const
    { return sRepositoryDirectory; }


class X_CommandLine
{
  public:
                        X_CommandLine(
                            const char *        i_sExplanation )
                            :   sExplanation(i_sExplanation) {}

    void                Report(
                            ostream &           o_rOut )
                            { o_rOut << "Error in command line: "
                                     << sExplanation << Endl(); }

  private:
    udmstri             sExplanation;
};

struct S_LanguageInfo
{
    enum E_ProgrammingLanguage
    {
        none,
        cpp,
        idl,
        corba,
        java
    };
                        S_LanguageInfo(
                            E_ProgrammingLanguage
                                                i_eLang );
    StringVector
                        aExtensions;        // An empty string is possible and means exactly that: files without extension.
    E_ProgrammingLanguage
                        eLanguage;
};

inline
S_LanguageInfo::S_LanguageInfo( E_ProgrammingLanguage i_eLang )
{
    eLanguage = i_eLang;
}

struct S_Sources
{
    StringVector        aDirectories;
    StringVector        aTrees;
    StringVector        aFiles;
};

struct S_ProjectData
{
                        S_ProjectData(
                            const char *        i_sName,
                            const char *        i_sRootDir );
                        ~S_ProjectData();

    udmstri             sName;
    csv::ploc::Path     aRootDirectory;

    Dyn<S_LanguageInfo> pLanguage;
    bool                bHtmlIsDefaultForDocs;

    S_Sources           aFiles;
};




const char * const C_opt_Verbose = "-v";

const char * const C_opt_Parse = "-parse";
const char * const C_opt_Name = "-name";
const char * const C_opt_Update = "-update";
const char * const C_opt_LangAll = "-lg";
const char * const C_opt_ExtensionsAll = "-extg";
const char * const C_opt_DocAll = "-docg";

const char * const C_arg_Usehtml = "usehtml";
const char * const C_arg_Cplusplus = "c++";
const char * const C_arg_Idl = "idl";
const char * const C_arg_Corba = "corba";
const char * const C_arg_Java = "java";

const char * const C_opt_Project = "-p";
const char * const C_opt_Lang = "-l";
const char * const C_opt_Extensions = "-ext";
const char * const C_opt_Doc = "-doc";
const char * const C_opt_SourceDir = "-d";
const char * const C_opt_SourceTree = "-t";
const char * const C_opt_SourceFile = "-f";

const char * const C_opt_Load = "-load";

const char * const C_opt_CreateHtml = "-html";
const char * const C_opt_ExternLinks = "-xlinks";

const char * const C_opt_CreateXml = "-xml";
const char * const C_opt_Save = "-save";

// IMPLEMENTATION



}   // namespace command
}   // namespace autodoc


#endif