1*1c78a5d6SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*1c78a5d6SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*1c78a5d6SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*1c78a5d6SAndrew Rist * distributed with this work for additional information 6*1c78a5d6SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*1c78a5d6SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*1c78a5d6SAndrew Rist * "License"); you may not use this file except in compliance 9*1c78a5d6SAndrew Rist * with the License. You may obtain a copy of the License at 10*1c78a5d6SAndrew Rist * 11*1c78a5d6SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*1c78a5d6SAndrew Rist * 13*1c78a5d6SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*1c78a5d6SAndrew Rist * software distributed under the License is distributed on an 15*1c78a5d6SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*1c78a5d6SAndrew Rist * KIND, either express or implied. See the License for the 17*1c78a5d6SAndrew Rist * specific language governing permissions and limitations 18*1c78a5d6SAndrew Rist * under the License. 19*1c78a5d6SAndrew Rist * 20*1c78a5d6SAndrew Rist *************************************************************/ 21*1c78a5d6SAndrew Rist 22*1c78a5d6SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef ARY_DOC_D_OLDCPPDOCU_HXX 25cdf0e10cSrcweir #define ARY_DOC_D_OLDCPPDOCU_HXX 26cdf0e10cSrcweir // KORR_DEPRECATED_3.0 27cdf0e10cSrcweir 28cdf0e10cSrcweir // BASE CLASSES 29cdf0e10cSrcweir #include <ary/doc/d_node.hxx> 30cdf0e10cSrcweir // USED SERVICES 31cdf0e10cSrcweir #include <ary/info/inftypes.hxx> 32cdf0e10cSrcweir #include <ary/ary_disp.hxx> 33cdf0e10cSrcweir 34cdf0e10cSrcweir namespace ary 35cdf0e10cSrcweir { 36cdf0e10cSrcweir namespace info 37cdf0e10cSrcweir { 38cdf0e10cSrcweir class AtTag; 39cdf0e10cSrcweir class DocuStore; 40cdf0e10cSrcweir } 41cdf0e10cSrcweir } 42cdf0e10cSrcweir 43cdf0e10cSrcweir 44cdf0e10cSrcweir 45cdf0e10cSrcweir 46cdf0e10cSrcweir namespace ary 47cdf0e10cSrcweir { 48cdf0e10cSrcweir namespace doc 49cdf0e10cSrcweir { 50cdf0e10cSrcweir using ::ary::info::AtTag; 51cdf0e10cSrcweir using ::ary::info::E_AtTagId; 52cdf0e10cSrcweir 53cdf0e10cSrcweir 54cdf0e10cSrcweir /** Wrapper class for old C++ documentation format. 55cdf0e10cSrcweir 56cdf0e10cSrcweir To be replaced by using the standard format. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir class OldCppDocu : public Node 59cdf0e10cSrcweir { 60cdf0e10cSrcweir public: 61cdf0e10cSrcweir typedef std::vector< DYN AtTag * > TagList; 62cdf0e10cSrcweir 63cdf0e10cSrcweir // LIFECYCLE 64cdf0e10cSrcweir OldCppDocu(); 65cdf0e10cSrcweir virtual ~OldCppDocu(); 66cdf0e10cSrcweir 67cdf0e10cSrcweir void Store2( 68cdf0e10cSrcweir info::DocuStore & o_rDocuStore ); 69cdf0e10cSrcweir 70cdf0e10cSrcweir virtual AtTag * Create_StdTag( 71cdf0e10cSrcweir E_AtTagId i_eId ); 72cdf0e10cSrcweir virtual AtTag * CheckIn_BaseTag(); 73cdf0e10cSrcweir virtual AtTag * CheckIn_ExceptionTag(); 74cdf0e10cSrcweir virtual AtTag * Create_ImplementsTag(); 75cdf0e10cSrcweir virtual AtTag * Create_KeywordTag(); 76cdf0e10cSrcweir virtual AtTag * CheckIn_ParameterTag(); 77cdf0e10cSrcweir virtual AtTag * CheckIn_SeeTag(); 78cdf0e10cSrcweir virtual AtTag * CheckIn_TemplateTag(); 79cdf0e10cSrcweir virtual AtTag * Create_LabelTag(); 80cdf0e10cSrcweir virtual AtTag * Create_DefaultTag(); 81cdf0e10cSrcweir virtual AtTag * Create_SinceTag(); /// @return always the first one created. 82cdf0e10cSrcweir 83cdf0e10cSrcweir virtual void Replace_AtShort_By_AtDescr(); 84cdf0e10cSrcweir 85cdf0e10cSrcweir virtual void Set_Obsolete(); 86cdf0e10cSrcweir virtual void Set_Internal(); Set_Interface()87cdf0e10cSrcweir virtual void Set_Interface() { bIsInterface = true; } 88cdf0e10cSrcweir 89cdf0e10cSrcweir // INQUIRY Tags() const90cdf0e10cSrcweir const TagList & Tags() const { return aTags; } 91cdf0e10cSrcweir const AtTag & Short() const; IsObsolete() const92cdf0e10cSrcweir bool IsObsolete() const { return bIsObsolete; } 93cdf0e10cSrcweir virtual bool IsInternal() const; 94cdf0e10cSrcweir virtual bool IsInterface() const; 95cdf0e10cSrcweir 96cdf0e10cSrcweir private: 97cdf0e10cSrcweir // Interface csv::ConstProcessorClient: 98cdf0e10cSrcweir virtual void do_Accept( 99cdf0e10cSrcweir csv::ProcessorIfc & io_processor ) const; 100cdf0e10cSrcweir // DATA 101cdf0e10cSrcweir unsigned char nTags[ary::info::C_eAtTag_NrOfClasses]; 102cdf0e10cSrcweir 103cdf0e10cSrcweir /** Creates a new AtTag at the end of aTags. 104cdf0e10cSrcweir The index of this new AtTag is inserted in nTags at position 105cdf0e10cSrcweir i_nIndex. 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir AtTag * & NewTag( 108cdf0e10cSrcweir UINT8 i_nIndex ); 109cdf0e10cSrcweir /** Returns the Tag with the position nTags[i_nIndex] 110cdf0e10cSrcweir in aTags. 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir AtTag & GetTag( 113cdf0e10cSrcweir UINT8 i_nIndex ); 114cdf0e10cSrcweir 115cdf0e10cSrcweir TagList aTags; 116cdf0e10cSrcweir bool bIsObsolete; 117cdf0e10cSrcweir bool bIsInternal; 118cdf0e10cSrcweir bool bIsInterface; 119cdf0e10cSrcweir }; 120cdf0e10cSrcweir 121cdf0e10cSrcweir 122cdf0e10cSrcweir 123cdf0e10cSrcweir 124cdf0e10cSrcweir } // namespace doc 125cdf0e10cSrcweir } // namespace ary 126cdf0e10cSrcweir #endif 127