autodoc/source/exes/adc_uni/cmd_sincedata.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: cmd_sincedata.hxx,v $
  10  * $Revision: 1.5 $
  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_CMD_SINCEDATA_HXX
  32 #define ADC_CMD_SINCEDATA_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 /** Provides replacements for the contents of the @@since documentation tag.
  49
  50     Because the @@since tag is part of the source code, it allows only one kind
  51     of version information there. If this is to be mapped for different products
  52     (example: from OpenOffice.org versions in the @@since tag to StarOffice or
  53     StarSuite products), the value of @@since needs a replacement, which is provided
  54     by this class.
  55
  56 */
  57 class SinceTagTransformationData : public Context
  58 {
  59   public:
  60     /** The key of this map are the version numbers within @since.
  61         The value is the string to display for each version number.
  62     */
  63     typedef std::map<String,String>     Map_Version2Display;
  64
  65     // LIFECYCLE
  66                         SinceTagTransformationData();
  67     virtual             ~SinceTagTransformationData();
  68
  69     // INQUIRY
  70     /// False, if no transformation table exists.
  71     bool                DoesTransform() const;
  72
  73     /** Gets the string to display for a version number.
  74
  75         @param i_sVersionNumber
  76         Usually should be the result of ->StripSinceTagValue().
  77     */
  78     const String &      DisplayOf(
  79                             const String &      i_sVersionNumber ) const;
  80   private:
  81     // Interface Context:
  82     virtual void        do_Init(
  83                             opt_iter &          i_nCurArgsBegin,
  84                             opt_iter            i_nEndOfAllArgs );
  85     // DATA
  86     Map_Version2Display aTransformationTable;
  87 };
  88
  89
  90 }   // namespace command
  91 }   // namespace autodoc
  92
  93
  94 #endif