File: Wm5Environment.h

package info (click to toggle)
libwildmagic 5.13-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 89,572 kB
  • ctags: 26,264
  • sloc: cpp: 210,924; csh: 637; sh: 95; makefile: 36
file content (64 lines) | stat: -rw-r--r-- 2,359 bytes parent folder | download | duplicates (3)
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
// Geometric Tools, LLC
// Copyright (c) 1998-2014
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt
// http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
//
// File Version: 5.0.1 (2010/10/01)

#ifndef WM5ENVIRONMENT_H
#define WM5ENVIRONMENT_H

#include "Wm5CoreLIB.h"
#include "Wm5InitTerm.h"

namespace Wm5
{

class WM5_CORE_ITEM Environment
{
    WM5_DECLARE_INITIALIZE;
    WM5_DECLARE_TERMINATE;

public:
    // Get the string corresponding to an environment variable.
    static std::string GetVariable (const std::string& varName);

    // Support for paths to locate files.  For platform independence, use
    // "/" for the path separator.  Please terminate the input 'directory'
    // values with "/".  The Insert/Remove functions return 'true' iff the
    // operation was successful.
    static int GetNumDirectories ();
    static std::string GetDirectory (int i);
    static bool InsertDirectory (const std::string& directory);
    static bool RemoveDirectory (const std::string& directory);
    static void RemoveAllDirectories ();

    // The GetPath* function searches the list of directories and returns the
    // fully decorated file name, assuming it satisfies the required
    // conditions, or returns "" if conditions are not met.  GetPathR succeeds
    // when the file can be opened for reading.  GetPathW succeeds when the
    // file can be opened for writing.  GetPathRW succedds when the file can
    // be opened for reading and/or writing.
    static std::string GetPath (const std::string& fileName, int mode);
    static std::string GetPathR (const std::string& fileName);
    static std::string GetPathW (const std::string& fileName);
    static std::string GetPathRW (const std::string& fileName);

private:
    static std::string GetPath (const std::string& filename,
        const char* attributes);

    // The list of directories for GetPath to search.  The list is
    // allocated during InitTerm::ExecuteInitializers.  As with other
    // classes in Wild Magic, no dynamic allocation occurs pre-main to
    // assist in tracking memory problems.
    static std::vector<std::string>* msDirectories;
};

WM5_REGISTER_INITIALIZE(Environment);
WM5_REGISTER_TERMINATE(Environment);

}

#endif