xref: /AOO41X/main/autodoc/inc/ary/qualiname.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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 ARY_QUALINAME_HXX
29*cdf0e10cSrcweir #define ARY_QUALINAME_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir // USED SERVICES
34*cdf0e10cSrcweir     // BASE CLASSES
35*cdf0e10cSrcweir     // COMPONENTS
36*cdf0e10cSrcweir     // PARAMETERS
37*cdf0e10cSrcweir #include <cosv/tpl/tpltools.hxx>
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir namespace ary
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir class QualifiedName
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir   public:
46*cdf0e10cSrcweir     typedef StringVector::const_iterator  namespace_iterator;
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir                         QualifiedName(
49*cdf0e10cSrcweir                             uintt               i_nSize = 0);
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir     /// @see AssignText()
52*cdf0e10cSrcweir                         QualifiedName(
53*cdf0e10cSrcweir                             const char *        i_sText,
54*cdf0e10cSrcweir                             const char *        i_sSeparator );
55*cdf0e10cSrcweir                         ~QualifiedName();
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir     QualifiedName &     operator+=(
58*cdf0e10cSrcweir                             const String &      i_sNamespaceName )
59*cdf0e10cSrcweir                                                 { if (i_sNamespaceName.length() > 0)
60*cdf0e10cSrcweir                                                         aNamespace.push_back(i_sNamespaceName);
61*cdf0e10cSrcweir                                                   return *this; }
62*cdf0e10cSrcweir     /// @precond i_nIndex < NamespaceDepth().
63*cdf0e10cSrcweir     String &            operator[](
64*cdf0e10cSrcweir                             uintt               i_nIndex )
65*cdf0e10cSrcweir                                                 { csv_assert(i_nIndex < aNamespace.size());
66*cdf0e10cSrcweir                                                   return aNamespace[i_nIndex]; }
67*cdf0e10cSrcweir     void                Init(
68*cdf0e10cSrcweir                             bool                i_bAbsolute )
69*cdf0e10cSrcweir                                                 { Empty(); bIsAbsolute = i_bAbsolute; }
70*cdf0e10cSrcweir     /** Reads a qualified name from a string.
71*cdf0e10cSrcweir         If the last two charcters are "()", the inquiry IsFunction() will return
72*cdf0e10cSrcweir         true.
73*cdf0e10cSrcweir     */
74*cdf0e10cSrcweir     void                AssignText(
75*cdf0e10cSrcweir                             const char *        i_sText,
76*cdf0e10cSrcweir                             const char *        i_sSeparator );
77*cdf0e10cSrcweir     void                SetLocalName(
78*cdf0e10cSrcweir                             const String &      i_sLocalName )
79*cdf0e10cSrcweir                                                 { sLocalName = i_sLocalName; }
80*cdf0e10cSrcweir     void                Empty()                 { csv::erase_container(aNamespace); sLocalName.clear(); bIsAbsolute = false; }
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir     const String &      LocalName() const       { return sLocalName; }
83*cdf0e10cSrcweir     namespace_iterator  first_namespace() const { return aNamespace.begin(); }
84*cdf0e10cSrcweir     namespace_iterator  end_namespace() const   { return aNamespace.end(); }
85*cdf0e10cSrcweir     uintt               NamespaceDepth() const  { return aNamespace.size(); }
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir     bool                IsAbsolute() const      { return bIsAbsolute; }
88*cdf0e10cSrcweir     bool                IsQualified() const     { return aNamespace.size() > 0; }
89*cdf0e10cSrcweir     bool                IsFunction() const      { return bIsFunction; }
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir   private:
92*cdf0e10cSrcweir     // DATA
93*cdf0e10cSrcweir     StringVector        aNamespace;
94*cdf0e10cSrcweir     String              sLocalName;
95*cdf0e10cSrcweir     bool                bIsAbsolute;            /// true := beginning with "::".
96*cdf0e10cSrcweir     bool                bIsFunction;            /// true := ending with "()"
97*cdf0e10cSrcweir };
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir 
102*cdf0e10cSrcweir }   // namespace ary
103*cdf0e10cSrcweir #endif
104