Imported Robodoc.
[robodoc.git] / Source / path.h
1 #ifndef ROBODOC_PATH_H
2 #define ROBODOC_PATH_H
3 /*
4 Copyright (C) 1994-2007  Frans Slothouber, Jacco van Weert, Petteri Kettunen,
5 Bernd Koesling, Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner,
6 Sasha Vasko, Kai Hofmann, Thierry Pierron, Friedrich Haase, and Gergely Budai.
7
8 This file is part of ROBODoc
9
10 ROBODoc is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23 */
24
25
26 /****s* ROBODoc/RB_Path
27  * NAME
28  *   RB_Path -- Path to a file
29  * ATTRIBUTES
30  *   * next  -- pointer to the next RB_Path structure.
31  *   * parent -- the parent path (one directory up).
32  *   * name  -- null terminated string with the name of the path.
33  *               (Path names can be relative)
34  *   * docname -- the corresponding docpath.
35  * SOURCE
36  */
37
38 struct RB_Path
39 {
40     struct RB_Path     *next;
41     struct RB_Path     *parent;
42     char               *name;
43     char               *docname;
44 };
45
46 /*****/
47
48 struct RB_Path     *RB_Get_RB_Path(
49     char *arg_pathname );
50 struct RB_Path     *RB_Get_RB_Path2(
51     char *arg_current_path,
52     char *arg_subdirectory );
53 void                RB_Free_RB_Path(
54     struct RB_Path *arg_rb_path );
55
56 #endif /* ROBODOC_PATH_H */