autodoc/source/exes/adc_uni/cmd_sincedata.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ADC_CMD_SINCEDATA_HXX
  30 #define ADC_CMD_SINCEDATA_HXX
  31
  32
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include "adc_cmd.hxx"
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40 namespace autodoc
  41 {
  42 namespace command
  43 {
  44
  45
  46 /** Provides replacements for the contents of the @@since documentation tag.
  47
  48     Because the @@since tag is part of the source code, it allows only one kind
  49     of version information there. If this is to be mapped for different products
  50     (example: from OpenOffice.org versions in the @@since tag to StarOffice or
  51     StarSuite products), the value of @@since needs a replacement, which is provided
  52     by this class.
  53
  54 */
  55 class SinceTagTransformationData : public Context
  56 {
  57   public:
  58     /** The key of this map are the version numbers within @since.
  59         The value is the string to display for each version number.
  60     */
  61     typedef std::map<String,String>     Map_Version2Display;
  62
  63     // LIFECYCLE
  64                         SinceTagTransformationData();
  65     virtual             ~SinceTagTransformationData();
  66
  67     // INQUIRY
  68     /// False, if no transformation table exists.
  69     bool                DoesTransform() const;
  70
  71     /** Gets the string to display for a version number.
  72
  73         @param i_sVersionNumber
  74         Usually should be the result of ->StripSinceTagValue().
  75     */
  76     const String &      DisplayOf(
  77                             const String &      i_sVersionNumber ) const;
  78   private:
  79     // Interface Context:
  80     virtual void        do_Init(
  81                             opt_iter &          i_nCurArgsBegin,
  82                             opt_iter            i_nEndOfAllArgs );
  83     // DATA
  84     Map_Version2Display aTransformationTable;
  85 };
  86
  87
  88 }   // namespace command
  89 }   // namespace autodoc
  90
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */