mirror of
https://github.com/boostorg/wave.git
synced 2026-01-27 07:22:15 +00:00
287 lines
9.9 KiB
C++
287 lines
9.9 KiB
C++
/*=============================================================================
|
|
Wave: A Standard compliant C++ preprocessor library
|
|
|
|
Sample: List include dependencies of a given source file
|
|
|
|
The 'list_includes' sample shows a simple way, how to use the Wave C++
|
|
preprocessor library to extract a list of included files from a given
|
|
source file.
|
|
To get a hint which commandline options are supported, call it with the
|
|
--help option.
|
|
|
|
Copyright (c) 2001-2004 Hartmut Kaiser
|
|
http://spirit.sourceforge.net/
|
|
|
|
Use, modification and distribution is subject to the Boost Software
|
|
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
|
http://www.boost.org/LICENSE_1_0.txt)
|
|
=============================================================================*/
|
|
|
|
#include "list_includes.hpp" // config data
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// include required boost libraries
|
|
#include <boost/assert.hpp>
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// This sample requires the program_options library written by Vladimir Prus,
|
|
// which is currently under Boost review.
|
|
// It is available here: http://boost-sandbox.sourceforge.net/program_options
|
|
//
|
|
#include <boost/program_options.hpp>
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// Include Wave itself
|
|
#include <boost/wave.hpp>
|
|
|
|
//#include <boost/wave/util/time_conversion_helper.hpp>
|
|
//#include <boost/wave/util/file_position.hpp>
|
|
|
|
#include <boost/wave/token_ids.hpp>
|
|
#include <boost/wave/cpplexer/cpp_lex_token.hpp>
|
|
#include <boost/wave/cpplexer/cpp_lex_iterator.hpp>
|
|
|
|
#include <boost/wave/trace_policies.hpp>
|
|
#include <boost/wave/cpp_context.hpp>
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// include lexer specifics, import lexer names
|
|
#if !defined(BOOST_WAVE_SEPARATE_LEXER_INSTANTIATION)
|
|
#include <boost/wave/cpplexer/re2clex/cpp_re2c_lexer.hpp>
|
|
#endif // !defined(BOOST_WAVE_SEPARATE_LEXER_INSTANTIATION)
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// import required names
|
|
using namespace boost::spirit;
|
|
|
|
using std::string;
|
|
using std::vector;
|
|
using std::set;
|
|
using std::cout;
|
|
using std::cerr;
|
|
using std::endl;
|
|
using std::ifstream;
|
|
using std::ostream;
|
|
using std::istreambuf_iterator;
|
|
|
|
namespace po = boost::program_options;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// print the current version
|
|
|
|
int print_version()
|
|
{
|
|
// get time of last compilation of this file
|
|
boost::wave::util::time_conversion_helper compilation_time(__DATE__ " " __TIME__);
|
|
|
|
// calculate the number of days since Jan 29 2003
|
|
// (the day the list_includes project was started)
|
|
std::tm first_day;
|
|
|
|
std::memset (&first_day, 0, sizeof(std::tm));
|
|
first_day.tm_mon = 0; // Jan
|
|
first_day.tm_mday = 29; // 29
|
|
first_day.tm_year = 103; // 2003
|
|
|
|
long seconds = long(std::difftime(compilation_time.get_time(),
|
|
std::mktime(&first_day)));
|
|
|
|
cout
|
|
<< LIST_INCLUDES_VERSION_MAJOR << '.'
|
|
<< LIST_INCLUDES_VERSION_MINOR << '.'
|
|
<< LIST_INCLUDES_VERSION_SUBMINOR << '.'
|
|
<< seconds/(3600*24); // get number of days from seconds
|
|
return 1; // exit app
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// policy class
|
|
struct trace_include_files
|
|
: public boost::wave::trace_policies::default_tracing
|
|
{
|
|
trace_include_files(set<string> &files_) : files(files_) {}
|
|
|
|
void
|
|
opened_include_file(string const &filename,
|
|
std::size_t include_depth, bool is_system_include)
|
|
{
|
|
set<string>::iterator it = files.find(filename);
|
|
if (it == files.end()) {
|
|
// print indented filename
|
|
for (size_t i = 0; i < include_depth; ++i)
|
|
cout << " ";
|
|
cout << filename << endl;
|
|
|
|
files.insert(filename);
|
|
}
|
|
}
|
|
|
|
set<string> &files;
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
int do_actual_work (
|
|
po::options_and_arguments const opts, po::variables_map const &vm,
|
|
vector<string> const &pathes, vector<string> const &syspathes)
|
|
{
|
|
// current file position is saved for exception handling
|
|
boost::wave::util::file_position_t current_position;
|
|
|
|
try {
|
|
vector<string> const &arguments = opts.arguments();
|
|
vector<string>::const_iterator lastfile = arguments.end();
|
|
|
|
for (vector<string>::const_iterator file_it = arguments.begin();
|
|
file_it != lastfile; ++file_it)
|
|
{
|
|
ifstream instream((*file_it).c_str());
|
|
string instring;
|
|
|
|
if (!instream.is_open()) {
|
|
cerr << "Could not open input file: " << *file_it << endl;
|
|
continue;
|
|
}
|
|
instream.unsetf(ios::skipws);
|
|
instring = string(istreambuf_iterator<char>(instream.rdbuf()),
|
|
istreambuf_iterator<char>());
|
|
|
|
// The template boost::wave::cpplexer::lex_token<> is the token type to be
|
|
// used by the Wave library.
|
|
typedef boost::wave::cpplexer::lex_iterator<
|
|
boost::wave::cpplexer::lex_token<> >
|
|
lex_iterator_t;
|
|
typedef boost::wave::context<
|
|
std::string::iterator, lex_iterator_t,
|
|
boost::wave::iteration_context_policies::load_file_to_string,
|
|
trace_include_files
|
|
> context_t;
|
|
|
|
set<string> files;
|
|
trace_include_files trace(files);
|
|
|
|
// The preprocessor iterator shouldn't be constructed directly. It is
|
|
// to be generated through a wave::context<> object. This wave:context<>
|
|
// object is additionally to be used to initialize and define different
|
|
// parameters of the actual preprocessing.
|
|
// The preprocessing of the input stream is done on the fly behind the
|
|
// scenes during iteration over the context_t::iterator_t stream.
|
|
context_t ctx (instring.begin(), instring.end(), (*file_it).c_str(), trace);
|
|
|
|
// add include directories to the include path
|
|
if (vm.count("path")) {
|
|
vector<string>::const_iterator end = pathes.end();
|
|
for (vector<string>::const_iterator cit = pathes.begin();
|
|
cit != end; ++cit)
|
|
{
|
|
ctx.add_include_path((*cit).c_str());
|
|
}
|
|
}
|
|
|
|
// add system include directories to the include path
|
|
if (vm.count("syspath")) {
|
|
vector<string>::const_iterator end = syspathes.end();
|
|
for (vector<string>::const_iterator cit = syspathes.begin();
|
|
cit != end; ++cit)
|
|
{
|
|
ctx.add_sysinclude_path((*cit).c_str());
|
|
}
|
|
}
|
|
|
|
// analyze the actual file
|
|
context_t::iterator_t first = ctx.begin();
|
|
context_t::iterator_t last = ctx.end();
|
|
|
|
cout << "Printing dependency information for: "
|
|
<< *file_it << endl;
|
|
|
|
while (first != last) {
|
|
current_position = (*first).get_position();
|
|
++first;
|
|
}
|
|
|
|
// prepend endl before next file
|
|
cout << endl;
|
|
}
|
|
}
|
|
catch (boost::wave::cpp_exception &e) {
|
|
// some preprocessing error
|
|
cerr
|
|
<< e.file_name() << "(" << e.line_no() << "): "
|
|
<< e.description() << endl;
|
|
return 2;
|
|
}
|
|
catch (std::exception &e) {
|
|
// use last recognized token to retrieve the error position
|
|
cerr
|
|
<< current_position.get_file()
|
|
<< "(" << current_position.get_line() << "): "
|
|
<< "exception caught: " << e.what()
|
|
<< endl;
|
|
return 3;
|
|
}
|
|
catch (...) {
|
|
// use last recognized token to retrieve the error position
|
|
cerr
|
|
<< current_position.get_file()
|
|
<< "(" << current_position.get_line() << "): "
|
|
<< "unexpected exception caught." << endl;
|
|
return 4;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// here we go!
|
|
int
|
|
main (int argc, char const *argv[])
|
|
{
|
|
try {
|
|
// analyze the command line options and arguments
|
|
vector<string> pathes;
|
|
vector<string> syspathes;
|
|
po::options_description desc("Usage: list_includes [options] file ...");
|
|
|
|
desc.add_options()
|
|
("help,h", "", "print out program usage (this message)")
|
|
("version,v", "", "print the version number")
|
|
("path,I", po::parameter<vector<string> >("dir", &pathes),
|
|
"specify additional include directory")
|
|
("syspath,S", po::parameter<vector<string> >("dir", &syspathes),
|
|
"specify additional system include directory")
|
|
;
|
|
|
|
po::options_and_arguments opts = po::parse_command_line(argc, argv, desc);
|
|
po::variables_map vm;
|
|
|
|
po::store(opts, vm, desc);
|
|
if (vm.count("help")) {
|
|
cout << desc << endl;
|
|
return 1;
|
|
}
|
|
|
|
if (vm.count("version")) {
|
|
return print_version();
|
|
}
|
|
|
|
// if there is no input file given, then exit
|
|
if (0 == opts.arguments().size()) {
|
|
cerr << "list_includes: No input file given. "
|
|
<< "Use --help to get a hint." << endl;
|
|
return 5;
|
|
}
|
|
|
|
// iterate over all given input files
|
|
return do_actual_work(opts, vm, pathes, syspathes);
|
|
}
|
|
catch (std::exception &e) {
|
|
cout << "list_includes: exception caught: " << e.what() << endl;
|
|
return 6;
|
|
}
|
|
catch (...) {
|
|
cerr << "list_includes: unexpected exception caught." << endl;
|
|
return 7;
|
|
}
|
|
}
|
|
|