jccl::ParseUtil Class Reference

Utility functions for handling the parsing of input files. More...

#include <jccl/Config/ParseUtil.h>

Collaboration diagram for jccl::ParseUtil:

[legend]List of all members.

Static Public Member Functions
static std::string	expandFileName (const std::string &name, const std::string &parentFile)
	Expands a filename to a string capable of being passed to an I/O system call.
static void	setCfgSearchPath (const std::string &path)
	Replaces the current configuration file search path with the given string.
Static Private Member Functions
static vpr::ReturnStatus	findFileUsingPath (const std::string &fileName, std::string &absoluteFile)
	Looks for a file in a path and opens it if found.
Static Private Attributes
static SearchPathData	mSearchInfo
Classes
struct	SearchPathData
	Simple helper type to ensure that the static data in this class is initialized at the same time. More...

---

Detailed Description

Utility functions for handling the parsing of input files.

Definition at line 48 of file ParseUtil.h.

---

Member Function Documentation

std::string jccl::ParseUtil::expandFileName	(	const std::string &	name,
		const std::string &	parentFile
	)			[static]

Expands a filename to a string capable of being passed to an I/O system call.

The result may be an absolute path depending on various factors.

Postcondition:

All environment variables used in name are expanded. If name is not an absolute path and parentFile is not an empty string, the path of parentFile will be prepended to the result. If parentFile is an empty string, the search path will be used to try to find the named file.

Parameters:

	name	The name to expand.
	parentFile	The name of the file that n is being loaded relative to.

Returns:

An expanded version of the string name. All environment

Note:

parentFile is always assumed to refer to a file, so if name is "included_file" and parentFile is "mydir/including_file", the result will be "mydir/included_file".

Definition at line 55 of file ParseUtil.cpp.

References findFileUsingPath(), and jcclDBG_CONFIG().

Referenced by jccl::ElementFactory::loadDef(), and jccl::ElementFactory::loadDefs().

{
   std::string fname = vpr::replaceEnvVars(name);

   fs::path fname_path(fname, fs::native);

   // If the given file name does not exist, try searching for it.
   if ( ! fs::exists(fname_path) )
   {
      // If the given file name is not absolute, look it up relative to
      // parentfile or using the config file search path.
      if ( ! fname_path.is_complete() )
      {
         // If the parentfile string is empty, we'll use the search path to
         // find the file.
         if ( parentfile.empty() )
         {
            vprDEBUG(jcclDBG_CONFIG, vprDBG_STATE_LVL)
               << "[jccl::ParseUtil::expandFileName()] Looking up '" << fname
               << "' using search path ...\n" << vprDEBUG_FLUSH;

            std::string absolute_fname;
            if ( findFileUsingPath(fname, absolute_fname).success() )
            {
               fname_path = fs::path(absolute_fname, fs::native);
            }
         }
         // parentfile is not empty, so we assume that fname is relative to
         // parentfile.
         else
         {
            fs::path parentfile_path(parentfile, fs::native);
            fs::path parentdir = parentfile_path.branch_path();
            fname_path = parentdir / fname_path;
         }
      }
   }

   return fname_path.native_file_string();
}

void jccl::ParseUtil::setCfgSearchPath

(

const std::string &

path

)

[static]

Replaces the current configuration file search path with the given string.

Parameters:

path

A string of directories separted by a platform-specific path separation character. On Windows, this character is ';', and on UNIX and Mac OS X, this character is ':'.

Definition at line 97 of file ParseUtil.cpp.

References mSearchInfo, and jccl::ParseUtil::SearchPathData::setSearchPath().

{
   mSearchInfo.setSearchPath(path);
}

vpr::ReturnStatus jccl::ParseUtil::findFileUsingPath	(	const std::string &	fileName,
		std::string &	absoluteFile
	)			[static, private]

Looks for a file in a path and opens it if found.

Parameters:

	fileName	The name of a file to search for.
	absoluteFile	Storage for the absolute path to the file if it was found in the path.

Returns:

vpr::ReturnStatus::Succeed is returned if a file is found in the path; vpr::ReturnStatus::Fail otherwise.

Definition at line 102 of file ParseUtil.cpp.

References jcclDBG_CONFIG(), jccl::ParseUtil::SearchPathData::mPath, and mSearchInfo.

Referenced by expandFileName().

{
   vpr::ReturnStatus status(vpr::ReturnStatus::Fail);
   fs::path filename_path(fileName, fs::native);

   for ( std::vector<std::string>::iterator i = mSearchInfo.mPath.begin();
         i != mSearchInfo.mPath.end();
         ++i )
   {
      fs::path full_path = fs::path(*i, fs::native) / filename_path;

      vprDEBUG(jcclDBG_CONFIG, vprDBG_HVERB_LVL)
         << "[jccl::ParseUtil::findFileUsingPath()] Attempting to open file '"
         << full_path.native_file_string() << "'\n" << vprDEBUG_FLUSH;

      try
      {
         if ( fs::exists(full_path) && ! fs::is_directory(full_path) )
         {
            status.setCode(vpr::ReturnStatus::Succeed);
            absoluteFile = full_path.native_file_string();
            break;
         }
      }
      catch(fs::filesystem_error&)
      {
         /* Ignore the exception. */ ;
      }
   }

   return status;
}

---

Member Data Documentation

ParseUtil::SearchPathData jccl::ParseUtil::mSearchInfo [static, private]

Definition at line 111 of file ParseUtil.h.

Referenced by findFileUsingPath(), setCfgSearchPath(), and jccl::ParseUtil::SearchPathData::setSearchPath().

---

The documentation for this class was generated from the following files:

• ParseUtil.h
• ParseUtil.cpp

---