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