diff --git a/LICENSE.txt b/LICENSE.txt index 3619ff30..70efdf21 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2013 Danny Y., Rapptz +Copyright (c) 2013-2015 Rapptz and contributors 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 diff --git a/README.md b/README.md index 5daebd20..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 @@ -30,7 +30,7 @@ struct vars { int main() { sol::state lua; - lua.new_userdata("vars", "boop", &vars::boop); + lua.new_usertype("vars", "boop", &vars::boop); lua.script("beep = vars.new()\n" "beep.boop = 1"); assert(lua.get("beep").boop == 1); @@ -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/bootstrap.py b/bootstrap.py index 1d6a0b3b..ce6750eb 100755 --- a/bootstrap.py +++ b/bootstrap.py @@ -50,7 +50,7 @@ args = parser.parse_args() # general variables include = [ '.', os.path.join('Catch', 'include')] depends = [] -cxxflags = [ '-Wall', '-Wextra', '-pedantic', '-pedantic-errors', '-std=c++11' ] +cxxflags = [ '-Wall', '-Wextra', '-pedantic', '-pedantic-errors', '-std=c++11', '-Wno-unused-variable' ] ldflags = [] script_dir = os.path.dirname(os.path.realpath(sys.argv[0])) sol_dir = os.path.join(script_dir, 'sol') diff --git a/examples/userdata.cpp b/examples/usertype.cpp similarity index 82% rename from examples/userdata.cpp rename to examples/usertype.cpp index e7f5d6f2..1a55a6dc 100644 --- a/examples/userdata.cpp +++ b/examples/usertype.cpp @@ -43,15 +43,15 @@ int main() { lua.open_libraries(sol::lib::base, sol::lib::math); // the simplest way to create a class is through - // sol::state::new_usertype + // sol::state::new_userdata // the first template is the class type // the rest are the constructor parameters - // using new_usertype you can only have one constructor + // using new_userdata you can only have one constructor // you must make sure that the name of the function // goes before the member function pointer - lua.new_usertype("foo", "print", &foo::print, "test", &foo::test); + lua.new_userdata("foo", "print", &foo::print, "test", &foo::test); // making the class from lua is simple // same with calling member functions @@ -63,8 +63,8 @@ int main() { assert(y == 14); // if you want a class to have more than one constructor - // the way to do so is through set_usertype and creating - // a usertype yourself with constructor types + // the way to do so is through set_userdata and creating + // a userdata yourself with constructor types { // Notice the brace: this means we're in a new scope @@ -75,7 +75,7 @@ int main() { // the first argument of construction is the name // second is the constructor types // then the rest are function name and member function pointer pairs - sol::usertype udata(ctor, "is_unit", &vector::is_unit); + sol::userdata udata("vector", ctor, "is_unit", &vector::is_unit); // then you must register it lua.set_usertype("vector", udata); @@ -83,7 +83,7 @@ int main() { // have to keep it around // cleanup happens automagically } - // calling it is the same as new_usertype + // calling it is the same as new_userdata lua.script("v = vector.new()\n" "v = vector.new(12)\n" @@ -92,7 +92,7 @@ int main() { // You can even have C++-like member-variable-access // just pass is public member variables in the same style as functions - lua.new_usertype("variables", "low_gravity", &variables::low_gravity, "boost_level", &variables::boost_level); + lua.new_userdata("variables", "low_gravity", &variables::low_gravity, "boost_level", &variables::boost_level); // making the class from lua is simple // same with calling member functions/variables diff --git a/single.py b/single.py new file mode 100644 index 00000000..f46d22df --- /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-2015 Rapptz and contributors + +// 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/debug.hpp b/sol/debug.hpp index 7311ac15..5ed2d9dc 100644 --- a/sol/debug.hpp +++ b/sol/debug.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/default_construct.hpp b/sol/default_construct.hpp index b8c3a3dd..6a6fef91 100644 --- a/sol/default_construct.hpp +++ b/sol/default_construct.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/demangle.hpp b/sol/demangle.hpp index 90bc0320..4a8f6350 100644 --- a/sol/demangle.hpp +++ b/sol/demangle.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 @@ -26,7 +26,7 @@ #include #include -#if (defined(__GNUC__) || defined(__clang__)) && !defined(_MSC_VER) +#if defined(__GNUC__) || defined(__clang__) #include #endif @@ -59,7 +59,7 @@ inline std::string demangle(const std::type_info& id) { while(found != std::string::npos) { realname.erase(found, removals[r].size()); found = realname.find(removals[r]); - } + } } for(std::size_t r = 0; r < replacements.size(); r+=2) { diff --git a/sol/deprecate.hpp b/sol/deprecate.hpp index b59cc74a..9bea4056 100644 --- a/sol/deprecate.hpp +++ b/sol/deprecate.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 @@ -34,10 +34,10 @@ namespace sol { namespace detail { - template - struct SOL_DEPRECATED deprecate_type { - using type = T; - }; + template + struct SOL_DEPRECATED deprecate_type { + using type = T; + }; } // detail } // sol diff --git a/sol/error.hpp b/sol/error.hpp index b3241ea9..1d5e4593 100644 --- a/sol/error.hpp +++ b/sol/error.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/function.hpp b/sol/function.hpp index a2da3e24..42b60278 100644 --- a/sol/function.hpp +++ b/sol/function.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/function_types.hpp b/sol/function_types.hpp index 927efea9..765d18dd 100644 --- a/sol/function_types.hpp +++ b/sol/function_types.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 @@ -47,7 +47,7 @@ struct functor { functor(FxArgs&&... fxargs): item(nullptr), invocation(std::forward(fxargs)...) {} bool check () const { - return invocation != nullptr; + return invocation != nullptr; } template diff --git a/sol/object.hpp b/sol/object.hpp index 142060aa..deeebb82 100644 --- a/sol/object.hpp +++ b/sol/object.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/proxy.hpp b/sol/proxy.hpp index 89e4495e..e3076043 100644 --- a/sol/proxy.hpp +++ b/sol/proxy.hpp @@ -1,6 +1,10 @@ // The MIT License (MIT) +<<<<<<< HEAD // Copyright (c) 2013-2015 Danny Y., Rapptz +======= +// Copyright (c) 2013-2015 Rapptz and contributors +>>>>>>> root/develop // 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 diff --git a/sol/reference.hpp b/sol/reference.hpp index 69e41720..1544d712 100644 --- a/sol/reference.hpp +++ b/sol/reference.hpp @@ -1,6 +1,10 @@ // The MIT License (MIT) +<<<<<<< HEAD // Copyright (c) 2013-2015 Danny Y., Rapptz +======= +// Copyright (c) 2013-2015 Rapptz and contributors +>>>>>>> root/develop // 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 diff --git a/sol/resolve.hpp b/sol/resolve.hpp index 8fa8aafd..9a6d501f 100644 --- a/sol/resolve.hpp +++ b/sol/resolve.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/stack.hpp b/sol/stack.hpp index 9356b507..203fc332 100644 --- a/sol/stack.hpp +++ b/sol/stack.hpp @@ -1,6 +1,10 @@ // The MIT License (MIT) +<<<<<<< HEAD // Copyright (c) 2013-2015 Danny Y., Rapptz +======= +// Copyright (c) 2013-2015 Rapptz and contributors +>>>>>>> root/develop // 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 diff --git a/sol/state.hpp b/sol/state.hpp index b4700ef6..394afe77 100644 --- a/sol/state.hpp +++ b/sol/state.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/table.hpp b/sol/table.hpp index 6bf20226..05557229 100644 --- a/sol/table.hpp +++ b/sol/table.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 @@ -25,7 +25,6 @@ #include "table_core.hpp" namespace sol { - typedef table_core table; -} // sol + typedef table_core } // sol #endif // SOL_TABLE_HPP diff --git a/sol/traits.hpp b/sol/traits.hpp index af3899e6..707be1be 100644 --- a/sol/traits.hpp +++ b/sol/traits.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/tuple.hpp b/sol/tuple.hpp index 0651a9f4..9c84d1b6 100644 --- a/sol/tuple.hpp +++ b/sol/tuple.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/types.hpp b/sol/types.hpp index ff8ffa65..b7dc0d90 100644 --- a/sol/types.hpp +++ b/sol/types.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 @@ -25,6 +25,7 @@ #include "compatibility.hpp" #include "traits.hpp" #include +#include "traits.hpp" namespace sol { struct nil_t {}; @@ -32,6 +33,9 @@ const nil_t nil {}; inline bool operator==(nil_t, nil_t) { return true; } inline bool operator!=(nil_t, nil_t) { return false; } +struct void_type : types {}; // This is important because it allows myobject.call( Void, ... ) to work +const void_type Void {}; + template struct function_sig_t {}; using function_t = function_sig_t<>; diff --git a/sol/usertype.hpp b/sol/usertype.hpp index c9eaccca..c5d72c9c 100644 --- a/sol/usertype.hpp +++ b/sol/usertype.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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 diff --git a/sol/usertype_traits.hpp b/sol/usertype_traits.hpp index 3dc9bfb3..5ad05512 100644 --- a/sol/usertype_traits.hpp +++ b/sol/usertype_traits.hpp @@ -1,6 +1,6 @@ // The MIT License (MIT) -// Copyright (c) 2013-2015 Danny Y., Rapptz +// Copyright (c) 2013-2015 Rapptz and contributors // 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