coan  6.0.1
A C/C++ Configuration Analyzer
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
directory_common.h
Go to the documentation of this file.
1 #ifndef DIRECTORY_COMMON_H
2 #define DIRECTORY_COMMON_H
3 #pragma once
4 /***************************************************************************
5  * Copyright (C) 2007-2013 Mike Kinghan, imk@burroingroingjoing.com *
6  * All rights reserved. *
7  * *
8  * Contributed originally by Mike Kinghan, imk@burroingroingjoing.com *
9  * *
10  * Redistribution and use in source and binary forms, with or without *
11  * modification, are permitted provided that the following conditions *
12  * are met: *
13  * *
14  * Redistributions of source code must retain the above copyright *
15  * notice, this list of conditions and the following disclaimer. *
16  * *
17  * Redistributions in binary form must reproduce the above copyright *
18  * notice, this list of conditions and the following disclaimer in the *
19  * documentation and/or other materials provided with the distribution. *
20  * *
21  * Neither the name of Mike Kinghan nor the names of its contributors *
22  * may be used to endorse or promote products derived from this software *
23  * without specific prior written permission. *
24  * *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT *
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS *
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE *
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, *
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, *
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS *
32  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED *
33  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,*
34  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF *
35  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH *
36  * DAMAGE. *
37  * *
38  **************************************************************************/
39 
44 #include <string>
45 
47 namespace common
48 {
49 
51 struct directory {
53  std::string const & path() const {
54  return _abs_path;
55  }
59  unsigned last_error() const {
60  return _last_error;
61  }
62 
66  void clear_error() {
67  _last_error = 0;
68  }
69 
71  bool good() const {
72  return !_last_error;
73  }
75  explicit operator bool () const {
76  return good();
77  }
78 
79 protected:
80 
84  explicit directory(std::string const & path);
85 
93  static bool is_dot_name(char const *leafname) {
94  return leafname[0] == '.' &&
95  (leafname[1] == 0 || (leafname[1] == '.' && leafname[2] == 0));
96  }
97 
99  std::string _abs_path;
101  unsigned _last_error = 0;
102 };
103 
104 
105 } // namespace common
106 
107 #endif
bool good() const
Say whether the directory is in a valid state.
static bool is_dot_name(char const *leafname)
Say whether a file leafname consists of 1 or 2 dots.
void clear_error()
Clear any system error code resulting from an operation on this directory.
struct common::directory encapsulates OS-neutral directory functionality.
directory(std::string const &path)
Explicitly construct a directory given a path.
std::string _abs_path
The absolute pathname of the directory.
unsigned last_error() const
Get the last system error code resulting from an operation on this directory.
Encapsulates a filesystem path.
Definition: path.h:59
std::string const & path() const
Get the absolute path of the directory
unsigned _last_error
The last error system code returned by a directory operation.