autodoc/source/exes/adc_uni/adc_cmd.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_cmd.hxx,v $
  10  * $Revision: 1.4 $
  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_CMD_HXX
  32 #define ADC_ADC_CMD_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <cosv/comdline.hxx>
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42
  43 namespace autodoc
  44 {
  45 namespace command
  46 {
  47
  48 /** Context for a command, which can be read from the command line.
  49 */
  50 class Context
  51 {
  52   public:
  53     typedef StringVector::const_iterator opt_iter;
  54
  55     virtual             ~Context() {}
  56
  57     void                Init(
  58                             opt_iter &          it,
  59                             opt_iter            itEnd );
  60   private:
  61     virtual void        do_Init(
  62                             opt_iter &          it,
  63                             opt_iter            itEnd ) = 0;
  64 };
  65
  66 // IMPLEMENTATION
  67 inline void
  68 Context::Init( opt_iter &          i_nCurArgsBegin,
  69                opt_iter            i_nEndOfAllArgs )
  70
  71 { do_Init(i_nCurArgsBegin, i_nEndOfAllArgs); }
  72
  73
  74
  75 /** Interface for commands, autodoc is able to perform.
  76 */
  77 class Command : public Context
  78 {
  79   public:
  80     /** Running ranks of the commands are to be maintained at one location:
  81         Here!
  82     */
  83     enum E_Ranks
  84     {
  85         rank_Load       = 10,
  86         rank_Parse      = 20,
  87         rank_Save       = 30,
  88         rank_CreateHtml = 40,
  89         rank_CreateXml  = 50
  90     };
  91
  92
  93     bool                Run() const;
  94     int                 RunningRank() const;
  95
  96   private:
  97     virtual bool        do_Run() const = 0;
  98     virtual int         inq_RunningRank() const = 0;
  99 };
 100
 101 // IMPLEMENTATION
 102 inline bool
 103 Command::Run() const
 104 { return do_Run(); }
 105 inline int
 106 Command::RunningRank() const
 107 { return inq_RunningRank(); }
 108
 109
 110
 111
 112 /** The exception thrown, if the command line is invalid.
 113 */
 114 class X_CommandLine
 115 {
 116   public:
 117                         X_CommandLine(
 118                             const char *        i_sExplanation )
 119                             :   sExplanation(i_sExplanation) {}
 120
 121     void                Report(
 122                             std::ostream &      o_rOut )
 123                             { o_rOut << "Error in command line: "
 124                                      << sExplanation << Endl(); }
 125   private:
 126     String              sExplanation;
 127 };
 128
 129
 130
 131
 132 }   // namespace command
 133 }   // namespace autodoc
 134 #endif