/usr/include/SurgSim/Framework/ApplicationData.h is in libopensurgsim-dev 0.7.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed 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.
#ifndef SURGSIM_FRAMEWORK_APPLICATIONDATA_H
#define SURGSIM_FRAMEWORK_APPLICATIONDATA_H
#include <string>
#include <vector>
#if !defined(SURGSIM_PARSED_BY_DOXYGEN) // do not generate documentation for Boost stuff!
namespace boost
{
namespace filesystem
{
class path;
} // namespace filesystem
} // namespace boost
#endif // defined(SURGSIM_PARSED_BY_DOXYGEN)
namespace SurgSim
{
namespace Framework
{
/// Enable searching for files in a given list of paths, give access to the current directory and
/// wrap boost::filesystem functionality
class ApplicationData
{
public:
/// Constructor, class is immutable, pass a list of paths to be used for searching duplicate
/// paths will be eliminated, invalid paths will be eliminated, the order of the paths given here
/// is the order that will be used in searching, the first occurrance of a file within a given
/// path will be used.
/// \param paths The list of search paths.
explicit ApplicationData(const std::vector<std::string>& paths);
/// Reads the search paths from a given configuration file
/// \param configFile The configuration file for reading the search paths.
explicit ApplicationData(const std::string& configFile);
~ApplicationData();
/// Gets the search paths.
/// \return The paths, passed in the constructor with duplicates and invalid paths
/// removed. All paths returned will be absolute and in system format.
std::vector<std::string> getPaths() const;
/// Searches for the first occurrence of fileName amongst the given paths, the
/// search is shallow, only direct content of the directories in the path list
/// will be used as search candidates.
/// \param fileName Filename of the file.
/// \return The absolute path to the file in system format i.e c:\\xxx\\yyy\\file.txt for
/// windows and /xxx/yyy/file.txt for all other systems. An empty string will be
/// returned if the file cannot be found.
std::string findFile(const std::string& fileName) const;
/// Searches for the first occurrence of fileName amongst the given paths, see findFile() for details.
/// If the file is found the full pathName will be sent in target and true returned. If the file is
/// not found the result will be false and the content of target will not change.
/// \param fileName Filename of the file.
/// \param target The location for the converted filename if it was found.
/// \return true if the file is found, false otherwise.
bool tryFindFile(const std::string& fileName, std::string* target) const;
/// Checks if the filename is acceptable
/// \param fileName Filename to be checked.
/// \return true if the name is valid, false otherwise.
bool isValidFilename(const std::string& fileName) const;
private:
/// Adds a single path to the list of search paths.
/// \param pathName Full pathname.
/// \return true if it succeeds, false if the given path does not exist or if it is
/// already in the list of paths.
bool addPath(const std::string& pathName);
/// Sets the list of search paths to be used for finding the location of files.
/// Eliminates duplicate paths and paths that do not exist
/// \param paths The paths to be used for finding files.
/// \return true if it succeeds, false if one or more of the paths
/// do not exist in the system or are duplicated.
bool setPaths(const std::vector<std::string>& paths);
std::vector<boost::filesystem::path> m_paths;
};
}; // Framework
}; // SurgSim
#endif // SURGSIM_FRAMEWORK_APPLICATIONDATA_H
|