autodoc/source/exes/adc_uni/adc_cmds.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: adc_cmds.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_ADC_CMDS_HXX
  32 #define ADC_ADC_CMDS_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include "adc_cmd.hxx"
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42 namespace autodoc
  43 {
  44 namespace command
  45 {
  46
  47
  48 /** A command that produces HTML output from the Autodoc Repository.
  49 */
  50 class CreateHtml : public Command
  51 {
  52   public:
  53                         CreateHtml();
  54                         ~CreateHtml();
  55
  56     const String &      OutputDir() const;
  57     const String &      DevelopersManual_HtmlRoot() const
  58                                                 { return sDevelopersManual_HtmlRoot; }
  59
  60   private:
  61     // Interface Context:
  62     virtual void        do_Init(
  63                             opt_iter &          i_nCurArgsBegin,
  64                             opt_iter            i_nEndOfAllArgs );
  65     // Interface Command:
  66     virtual bool        do_Run() const;
  67     virtual int         inq_RunningRank() const;
  68
  69     // Locals
  70     void                run_Cpp() const;
  71     void                run_Idl() const;
  72
  73     // DATA
  74     String              sOutputRootDirectory;
  75     String              sDevelopersManual_HtmlRoot;
  76 };
  77
  78 inline const String &
  79 CreateHtml::OutputDir() const
  80     { return sOutputRootDirectory; }
  81
  82
  83 extern const String C_opt_Verbose;
  84
  85 extern const String C_opt_Parse;
  86 extern const String C_opt_Name;
  87 extern const String C_opt_LangAll;
  88 extern const String C_opt_ExtensionsAll;
  89 extern const String C_opt_DevmanFile;
  90 extern const String C_opt_SinceFile;
  91
  92 extern const String C_arg_Cplusplus;
  93 extern const String C_arg_Idl;
  94 extern const String C_arg_Java;
  95
  96 extern const String C_opt_Project;
  97 //extern const String C_opt_Lang;
  98 //extern const String C_opt_Extensions;
  99 extern const String C_opt_SourceTree;
 100 extern const String C_opt_SourceDir;
 101 extern const String C_opt_SourceFile;
 102
 103 extern const String C_opt_CreateHtml;
 104 extern const String C_opt_DevmanRoot;
 105
 106 //extern const String C_opt_CreateXml;
 107 //extern const String C_opt_Load;
 108 //extern const String C_opt_Save;
 109
 110 extern const String C_opt_ExternNamespace;
 111 extern const String C_opt_ExternRoot;
 112
 113
 114 inline void
 115 CHECKOPT( bool b, const char * miss, const String & opt )
 116 {
 117     if ( NOT b )
 118     {
 119         StreamLock slMsg(100);
 120         throw X_CommandLine( slMsg() << "Missing " << miss <<" after " << opt << "." << c_str );
 121     }
 122 }
 123
 124 }   // namespace command
 125 }   // namespace autodoc
 126
 127
 128 #endif