1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #ifndef ADC_DISPLAY_OUT_POSITION_HXX
25*b1cdbd2cSJim Jagielski #define ADC_DISPLAY_OUT_POSITION_HXX
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski
28*b1cdbd2cSJim Jagielski // USED SERVICES
29*b1cdbd2cSJim Jagielski // BASE CLASSES
30*b1cdbd2cSJim Jagielski // COMPONENTS
31*b1cdbd2cSJim Jagielski #include <toolkit/out_node.hxx>
32*b1cdbd2cSJim Jagielski // PARAMETERS
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski namespace output
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski class Position
42*b1cdbd2cSJim Jagielski {
43*b1cdbd2cSJim Jagielski public:
44*b1cdbd2cSJim Jagielski // LIFECYCLE
45*b1cdbd2cSJim Jagielski Position();
46*b1cdbd2cSJim Jagielski explicit Position(
47*b1cdbd2cSJim Jagielski Node & i_directory,
48*b1cdbd2cSJim Jagielski const String & i_file = String::Null_() );
49*b1cdbd2cSJim Jagielski Position(
50*b1cdbd2cSJim Jagielski const Position & i_directory,
51*b1cdbd2cSJim Jagielski const String & i_rDifferentFile );
52*b1cdbd2cSJim Jagielski ~Position();
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski // OPERATIONS
55*b1cdbd2cSJim Jagielski Position & operator=(
56*b1cdbd2cSJim Jagielski Node & i_node );
57*b1cdbd2cSJim Jagielski Position & operator+=(
58*b1cdbd2cSJim Jagielski const String & i_nodeName );
59*b1cdbd2cSJim Jagielski Position & operator-=(
60*b1cdbd2cSJim Jagielski intt i_levels );
61*b1cdbd2cSJim Jagielski
62*b1cdbd2cSJim Jagielski // INQUIRY
IsValid() const63*b1cdbd2cSJim Jagielski bool IsValid() const { return pDirectory->Depth() >= 0; }
Name() const64*b1cdbd2cSJim Jagielski const String & Name() const { return pDirectory->Name(); }
File() const65*b1cdbd2cSJim Jagielski const String & File() const { return sFile; }
Depth() const66*b1cdbd2cSJim Jagielski intt Depth() const { return pDirectory->Depth(); }
67*b1cdbd2cSJim Jagielski
Get_Chain(StringVector & o_result) const68*b1cdbd2cSJim Jagielski void Get_Chain(
69*b1cdbd2cSJim Jagielski StringVector & o_result ) const
70*b1cdbd2cSJim Jagielski { pDirectory->Get_Chain(o_result); }
71*b1cdbd2cSJim Jagielski String LinkToRoot(
72*b1cdbd2cSJim Jagielski const String & i_localLabel = String::Null_() ) const;
73*b1cdbd2cSJim Jagielski
74*b1cdbd2cSJim Jagielski void Get_LinkTo(
75*b1cdbd2cSJim Jagielski StreamStr & o_result,
76*b1cdbd2cSJim Jagielski const Position & i_destination,
77*b1cdbd2cSJim Jagielski const String & i_localLabel = String::Null_() ) const;
78*b1cdbd2cSJim Jagielski void Get_LinkToRoot(
79*b1cdbd2cSJim Jagielski StreamStr & o_result,
80*b1cdbd2cSJim Jagielski const String & i_localLabel = String::Null_() ) const;
81*b1cdbd2cSJim Jagielski
Delimiter()82*b1cdbd2cSJim Jagielski static char Delimiter() { return '/'; }
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski // ACCESS
RelatedNode() const85*b1cdbd2cSJim Jagielski Node & RelatedNode() const { return *pDirectory; }
86*b1cdbd2cSJim Jagielski
87*b1cdbd2cSJim Jagielski void Set(
88*b1cdbd2cSJim Jagielski Node & i_node,
89*b1cdbd2cSJim Jagielski const String & i_file = String::Null_() );
90*b1cdbd2cSJim Jagielski void Set_File(
91*b1cdbd2cSJim Jagielski const String & i_file );
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski private:
94*b1cdbd2cSJim Jagielski // DATA
95*b1cdbd2cSJim Jagielski String sFile;
96*b1cdbd2cSJim Jagielski Node * pDirectory;
97*b1cdbd2cSJim Jagielski };
98*b1cdbd2cSJim Jagielski
99*b1cdbd2cSJim Jagielski
100*b1cdbd2cSJim Jagielski /// @return No delimiter at start, with delimiter at end.
101*b1cdbd2cSJim Jagielski const char * get_UpLink(
102*b1cdbd2cSJim Jagielski uintt i_depth );
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski
105*b1cdbd2cSJim Jagielski // IMPLEMENTATION
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski inline void
Set_File(const String & i_file)108*b1cdbd2cSJim Jagielski Position::Set_File( const String & i_file )
109*b1cdbd2cSJim Jagielski { sFile = i_file; }
110*b1cdbd2cSJim Jagielski
111*b1cdbd2cSJim Jagielski } // namespace output
112*b1cdbd2cSJim Jagielski
113*b1cdbd2cSJim Jagielski #endif
114