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
|
/** @file
Layout
@section license License
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
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@section details Details
Part of the utils library which contains classes that use multiple
components of the IO-Core to implement some useful functionality. The
classes also serve as good examples of how to use the IO-Core.
*/
#ifndef _I_Layout_h
#define _I_Layout_h
/**
The Layout is a simple place holder for the distribution layout.
*/
struct Layout {
char *prefix;
char *exec_prefix;
char *bindir;
char *sbindir;
char *sysconfdir;
char *datadir;
char *includedir;
char *libdir;
char *libexecdir;
char *localstatedir;
char *sharedstatedir;
char *runtimedir;
char *logdir;
char *mandir;
char *infodir;
char *cachedir;
Layout(const char *prefix = 0);
~Layout();
/**
Return file path relative to Layout->prefix
Memory is allocated, so use ats_free() when no longer needed
*/
char *relative(const char *file);
/**
update the sysconfdir to a test conf dir
*/
void update_sysconfdir(const char *dir);
/**
Return file path relative to Layout->prefix
Store the path to buf. The buf should be large eough to store
PATH_NAME_MAX characters
*/
void relative(char *buf, size_t bufsz, const char *file);
/**
Return file path relative to dir
Memory is allocated, so use ats_free() when no longer needed
Example usage: Layout::relative_to(default_layout()->sysconfdir, "foo.bar");
*/
static char *relative_to(const char *dir, const char *file);
/**
Return file path relative to dir
Store the path to buf. The buf should be large eough to store
PATH_NAME_MAX characters
Example usage: Layout::relative_to(default_layout()->sysconfdir, "foo.bar");
*/
static void relative_to(char *buf, size_t bufsz, const char *dir, const char *file);
/**
Creates a Layout Object with the given prefix. If no
prefix is given, the prefix defaults to the one specified
at the compile time.
*/
static void create(const char *prefix = 0);
/**
Returns the Layout object created by create_default_layout().
*/
static Layout *get();
};
#endif
|
