blob: 3b16920d83544713f8d8c444a184db3caf00583d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef ADC_DISPLAY_HI_ENV_HXX
#define ADC_DISPLAY_HI_ENV_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
#include <cosv/ploc.hxx>
#include <cosv/ploc_dir.hxx>
// PARAMETERS
#include <toolkit/out_position.hxx>
namespace ary
{
namespace idl
{
class Gate;
class CodeEntity;
}
}
namespace display
{
class CorporateFrame;
}
namespace output
{
class Tree;
}
class AryAccess;
class LinkHelper;
/** @resp
Provides enviroment information to the HTML factory
classes.
@descr
All information that is not included in the data, especially
about the layout of the output tree and the access to
information from the repository are provided here.
@see HtmlFactory
*/
class HtmlEnvironment_Idl
{
public:
// LIFECYCLE
HtmlEnvironment_Idl(
const csv::ploc::Path &
io_rOutputDir,
const ary::idl::Gate &
i_rGate,
const display::CorporateFrame &
i_rLayout );
~HtmlEnvironment_Idl();
// OPERATIONS
void Goto_Directory(
output::Position i_pos,
bool i_bCreateDirectoryIfNecessary );
void Goto_DirectoryLevelDown(
const String & i_subDirName,
bool i_bCreateDirectoryIfNecessary );
void Goto_DirectoryLevelUp();
void Set_CurFile(
const String & i_fileName );
void Set_CurPageCe(
const ary::idl::CodeEntity *
i_ce )
{ pCurPageCe = i_ce; }
// INQUIRY
const ary::idl::Gate &
Gate() const { return *pGate; }
const AryAccess & Data() const { return *pData; }
const char * Link2Manual(
const String & i_link ) const;
/// This may be reimplemented for removing dead links to members.
bool Is_MemberExistenceCheckRequired() const
{ return false; }
/// @return Holds only the current directory, not the current file.
output::Position & CurPosition() const { return aCurPosition; }
void Get_CurFilePath(
StreamStr & o_buffer ) const
{ o_buffer << aCurPath; }
const display::CorporateFrame &
Layout() const { return *pLayout; }
const LinkHelper & Linker() const { return *pLinker; }
void Get_LinkTo(
StreamStr & o_result,
output::Position i_destination )
{ CurPosition().Get_LinkTo(o_result, i_destination); }
String CurPageCe_AsText() const;
String CurPageCe_AsFile(
const char * i_sEnding) const;
const ary::idl::CodeEntity *
CurPageCe() const { return pCurPageCe; }
// ACCESS
output::Tree & OutputTree() { return *pOutputTree; }
private:
// Local
void create_Directory(
const csv::ploc::Path &
i_path );
// DATA
csv::ploc::Directory
aOutputRoot;
csv::ploc::Path aCurPath;
Dyn<AryAccess> pData; /// @invariant *pData is valid.
const ary::idl::Gate *
pGate; /// @invariant pGate != 0.
Dyn<output::Tree> pOutputTree; /// @invariant *pOutputTree is valid.
mutable output::Position
aCurPosition;
const ary::idl::CodeEntity *
pCurPageCe;
const display::CorporateFrame *
pLayout;
Dyn<LinkHelper> pLinker;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
