Source: ../../rtrmgr/util.hh
|
|
|
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001-2008 XORP, Inc.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
//
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net
// $XORP: xorp/rtrmgr/util.hh,v 1.18 2008/10/02 21:58:26 bms Exp $
#ifndef __RTRMGR_UTIL_HH__
#define __RTRMGR_UTIL_HH__
/**
* Initialize paths.
*
* This method attempts to determine where XORP is being run from and
* initialize paths accordingly. If the environment variable
* XORP_ROOT is set, this overrides the path determination algorithm.
*
* This method should be called before any
* of the following methods:
*
* @li @ref xorp_binary_root_dir()
* @li @ref xorp_config_root_dir()
* @li @ref xorp_template_dir()
* @li @ref xorp_xrl_targets_dir()
* @li @ref xorp_boot_file()
*
* @param argv0 the argv[0] supplied to main().
*/
void xorp_path_init(const char* argv0);
/**
* Return top-level directory of xorp binaries.
*
* @ref xorp_path_init() must be called before this method will return a sane
* value.
*/
const string& xorp_binary_root_dir();
/**
* Return top-level directory of xorp configuration files.
*
* @ref xorp_path_init() must be called before this method will return a sane
* value.
*/
const string& xorp_config_root_dir();
/**
* Return the path of the xorp templates directory given the xorp_root
* path.
*
* @ref xorp_path_init() must be called before this method will return a sane
* value.
*/
string xorp_template_dir();
/**
* Return the path of the xrl targets directory given the xorp_root
* path.
*
* @ref xorp_path_init() must be called before this method will return a sane
* value.
*/
string xorp_xrl_targets_dir();
/**
* Return path of boot config file to be used given the xorp_root path.
*
* @ref xorp_path_init() must be called before this method will return a sane
* value.
*/
string xorp_boot_file();
/**
* Remove enclosing quotes from string.
*
* @param s string that may have enclosing quotes.
* @return string with quotes removed.
*/
string& unquote(string& s);
/**
* Remove enclosing quotes from string value.
*
* @param s string that may have enclosing quotes.
* @return copy of string with quotes removed.
*/
string unquote(const string& s);
/**
* Test if a string should be in quotes.
* A string should be in quotes if it contains a character that is not
* a letter or a digit.
*
* @param s the string to test.
* @return true if the string should be in quotes, otherwise false.
*/
bool is_quotable_string(const string& s);
/**
* Find the name (including the path) of an executable program.
*
* If the filename contains an absolute pathname, then we return the
* program filename or an error if the program is not executable.
* If the pathname is relative, then first we consider the XORP binary
* root directory, and then the directories in the user's PATH environment.
*
* @param program_filename the name of the program to find.
* @return the name of the executable program on success, empty string
* on failure.
*/
string find_executable_filename(const string& program_filename);
/**
* Find the name (including the path) and the arguments of an executable
* program and return them by reference.
*
* If the filename contains an absolute pathname, then we return-by-reference
* the program filename or an error if the program is not executable.
* If the pathname is relative, then first we consider the XORP binary
* root directory, and then the directories in the user's PATH environment.
*
* @param program_request a string with the name of the program to find
* and its arguments.
* @param executable_filename the return-by-reference name of the executable
* program on success, empty string on failure.
* @param program_arguments the return-by-reference program arguments,
* or an empty string if no arguments were supplied.
*/
void find_executable_filename_and_arguments(const string& program_request,
string& executable_filename,
string& program_arguments);
#endif // __RTRMGR_UTIL_HH__
Generated by: pavlin on kobe.xorp.net on Wed Dec 24 16:29:21 2008, using kdoc 2.0a54+XORP.