diff --git a/README.md b/README.md index ce908c98..39d1c045 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/Rapptz/sol.svg?branch=master)](https://travis-ci.org/Rapptz/sol) -Sol is a C++ library binding to Lua. It currently supports Lua 5.2. Sol aims to be easy to use and easy to add to a project. +Sol is a C++ library binding to Lua. It currently supports Lua 5.2+. Sol aims to be easy to use and easy to add to a project. At this time, the library is header-only for easy integration with projects. ## Sneak Peek @@ -39,6 +39,10 @@ int main() { More examples are given in the examples directory. +## Creating a single header + +For maximum ease of use, a script called `single.py` is provided. You can run this script to create a single file version of the library so you can only include that part of it. Check `single.py --help` for more info. + ## Features - Supports retrieval and setting of multiple types including `std::string`. diff --git a/single.py b/single.py new file mode 100644 index 00000000..bafad43f --- /dev/null +++ b/single.py @@ -0,0 +1,164 @@ +#!/usr/bin/env python + +import argparse +import os, sys +import re +import datetime as dt + +# python 3 compatibility +try: + import cStringIO as sstream +except ImportError: + import io.StringIO as sstream + +description = "Converts sol to a single file for convenience." + +# command line parser +parser = argparse.ArgumentParser(usage='%(prog)s [options...]', description=description) +parser.add_argument('--output', '-o', help='name and location of where to place file', metavar='file', default='sol.hpp') +parser.add_argument('--quiet', help='suppress all output', action='store_true') +args = parser.parse_args() + +script_path = os.path.normpath(os.path.dirname(os.path.realpath(__file__))) +working_dir = os.getcwd() +os.chdir(script_path) + +intro = """// The MIT License (MIT) + +// Copyright (c) 2013 Danny Y., Rapptz + +// Permission is hereby granted, free of charge, to any person obtaining a copy of +// this software and associated documentation files (the "Software"), to deal in +// the Software without restriction, including without limitation the rights to +// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +// the Software, and to permit persons to whom the Software is furnished to do so, +// subject to the following conditions: + +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. + +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +// This file was generated with a script. +// Generated {time} UTC +// This header was generated with sol {version} (revision {revision}) +// https://github.com/Rapptz/sol + +#ifndef {guard} +#define {guard} + +""" + +module_path = os.path.join(script_path) + +includes = set([]) +standard_include = re.compile(r'#include <(.*?)>') +local_include = re.compile(r'#include "(.*?)"') +ifndef_cpp = re.compile(r'#ifndef SOL_.*?_HPP') +define_cpp = re.compile(r'#define SOL_.*?_HPP') +endif_cpp = re.compile(r'#endif // SOL_.*?_HPP') + +def get_include(line, base_path): + local_match = local_include.match(line) + if local_match: + # local include found + full_path = os.path.normpath(os.path.join(base_path, local_match.group(1))).replace('\\', '/') + return full_path + + return None + + +def is_include_guard(line): + return ifndef_cpp.match(line) or define_cpp.match(line) or endif_cpp.match(line) + +def get_revision(): + return os.popen('git rev-parse --short HEAD').read().strip() + +def get_version(): + return os.popen('git describe --tags --abbrev=0').read().strip() + +def process_file(filename, out): + global includes + filename = os.path.normpath(filename) + + if filename in includes: + return + + includes.add(filename) + + if not args.quiet: + print('processing {}'.format(filename)) + + out.write('// beginning of {}\n\n'.format(filename)) + empty_line_state = True + + with open(filename, 'r') as f: + for line in f: + # skip comments + if line.startswith('//'): + continue + + # skip include guard non-sense + if is_include_guard(line): + continue + + # get relative directory + base_path = os.path.dirname(filename) + + # check if it's a standard file + std = standard_include.search(line) + if std: + std_file = os.path.join('std', std.group(0)) + if std_file in includes: + continue + includes.add(std_file) + + # see if it's an include file + name = get_include(line, base_path) + + if name: + process_file(name, out) + continue + + empty_line = len(line.strip()) == 0 + + if empty_line and empty_line_state: + continue + + empty_line_state = empty_line + + # line is fine + out.write(line) + + out.write('// end of {}\n\n'.format(filename)) + + +version = get_version() +revision = get_revision() +include_guard = 'SOL_SINGLE_INCLUDE_HPP' + +if not args.quiet: + print('Creating single header for sol') + print('Current version: {version} (revision {revision})\n'.format(version = version, revision = revision)) + + +processed_files = [os.path.join(script_path, 'sol', x) for x in ('state.hpp', 'object.hpp', 'function.hpp')] +result = '' + +ss = sstream.StringIO() +ss.write(intro.format(time=dt.datetime.utcnow(), revision=revision, version=version, guard=include_guard)) +for processed_file in processed_files: + process_file(processed_file, ss) + +ss.write('#endif // {}\n'.format(include_guard)) +result = ss.getvalue() +ss.close() + +with open(args.output, 'w') as f: + f.write(result) + diff --git a/sol.hpp b/sol.hpp deleted file mode 100644 index ce093f66..00000000 --- a/sol.hpp +++ /dev/null @@ -1,29 +0,0 @@ -// The MIT License (MIT) - -// Copyright (c) 2013 Danny Y., Rapptz - -// Permission is hereby granted, free of charge, to any person obtaining a copy of -// this software and associated documentation files (the "Software"), to deal in -// the Software without restriction, including without limitation the rights to -// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -// the Software, and to permit persons to whom the Software is furnished to do so, -// subject to the following conditions: - -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. - -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -#ifndef SOL_HPP -#define SOL_HPP - -#include "sol/state.hpp" -#include "sol/object.hpp" -#include "sol/function.hpp" - -#endif // SOL_HPP