1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef ARY_IDL_IK_CE_HXX 25 #define ARY_IDL_IK_CE_HXX 26 // KORR_DEPRECATED_3.0 27 28 29 30 // USED SERVICES 31 // BASE CLASSES 32 // COMPONENTS 33 // PARAMETERS 34 #include <ary/idl/i_types4idl.hxx> 35 #include <ary/stdconstiter.hxx> 36 37 namespace ary 38 { 39 namespace info 40 { 41 class Text; 42 } 43 namespace idl 44 { 45 46 47 namespace ifc_ce 48 { 49 50 51 typedef ::ary::Dyn_StdConstIterator<Ce_id> Dyn_CeIterator; 52 typedef ::ary::Dyn_StdConstIterator<Type_id> Dyn_TypeIterator; 53 typedef ::ary::info::Text DocText; 54 55 56 57 struct attr 58 { 59 static Ce_id CeId( 60 const CodeEntity & i_ce ); 61 static const String & 62 LocalName( 63 const CodeEntity & i_ce ); 64 static Ce_id NameRoom( 65 const CodeEntity & i_ce ); 66 static Rid Owner( 67 const CodeEntity & i_ce ); 68 static E_SightLevel SightLevel( 69 const CodeEntity & i_ce ); Search_Memberary::idl::ifc_ce::attr70 static bool Search_Member( 71 const CodeEntity & , 72 const String & ) 73 { return true; } // KORR_FUTURE 74 }; 75 76 struct xref 77 { 78 }; 79 80 struct doc 81 { 82 static const DocText & 83 ShortInfo( /// @return a short description of the CodeEntity 84 const CodeEntity & i_ce ); 85 86 static const DocText & 87 TagAuthor( 88 const CodeEntity & i_ce ); 89 static const DocText & 90 TagExample( 91 const CodeEntity & i_ce ); 92 static const DocText & 93 TagDescr( 94 const CodeEntity & i_ce ); 95 static const DocText & 96 TagGuarantees( 97 const CodeEntity & i_ce ); 98 static const DocText & 99 TagKey( 100 const CodeEntity & i_ce ); 101 static const DocText & 102 TagMissing( 103 const CodeEntity & i_ce ); 104 static const DocText & 105 TagSee( 106 const CodeEntity & i_ce ); 107 static const DocText & 108 TagShort( 109 const CodeEntity & i_ce ); 110 static const DocText & 111 TagVersion( 112 const CodeEntity & i_ce ); 113 114 void Get_UnkownTags( 115 Dyn_CeIterator & o_result, 116 const CodeEntity & i_ce ); 117 118 bool IsDeprecated( 119 const CodeEntity & i_ce ); 120 bool IsIncomplete( 121 const CodeEntity & i_ce ); 122 bool IsInternal( 123 const CodeEntity & i_ce ); 124 bool IsNodoc( 125 const CodeEntity & i_ce ); 126 bool IsOptional( 127 const CodeEntity & i_ce ); 128 bool IsSuspicious( 129 const CodeEntity & i_ce ); 130 131 }; 132 133 134 } // namespace ifc_ce 135 136 137 } // namspace idl 138 } // namspace ary 139 140 #endif 141 142 143