redstrate/prism
Archived
1
Fork 0
Code Activity

Clean up metal-cpp folder

Browse source 
I removed the useless python script and now the README and LICENSE isn't in the public header folder.
This commit is contained in:
Joshua Goins 2022-02-18 15:19:07 -05:00
parent dfcade8a29
commit 7c31143d26
3 changed files with 0 additions and 718 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

202
extern/metal-cpp/include/LICENSE.txt vendored
View file

@ -1,202 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright © 2021 Apple Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

245
extern/metal-cpp/include/README.md vendored
View file

@ -1,245 +0,0 @@
## About
**metal-cpp** is a low overhead and header only C++ interface for Metal that helps developers add Metal functionality to graphics applications that are written in C++ (such as game engines). **metal-cpp** removes the need to create a shim and allows developers to call Metal functions directly from anywhere in their existing C++ code.
## Highlights
- Drop in C++ alternative interface to the Metal Objective-C headers.
- Direct mapping of all Metal Objective-C classes, constants and enums to C++ in the MTL C++ namespace.
- No measurable overhead compared to calling Metal Objective-C headers, due to inlining of C++ function calls.
- No usage of wrapper containers that require additional allocations.
- Requires C++17 due to the usage of `constexpr` in `NS::Object`.
- Identical header files and function/constant/enum availability for iOS, macOS and tvOS.
- Backwards compatibility: All `bool MTL::Device::supports...()` functions check if their required selectors exist and automatically return `false` if not.
- String (`ErrorDomain`) constants are weak linked and automatically set to `nullptr` if not available.
## Memory Allocation Policy
**metal-cpp** follows the object allocation policies of Cocoa and Cocoa Touch. Understanding those rules is especially important when using metal-cpp, as C++ objects are not eligible for automatic reference counting (ARC).
**metal-cpp** objects are reference counted. To help convey and manage object lifecycles, the following conventions are observed:
1. *You own any object returned by methods whose name begins with* `alloc` *,* `new` *,* `copy` *, or* `mutableCopy`. The method returns these objects with `retainCount` equals to `1`.
2. *You can take ownership of an object by calling its* ```retain()``` *method*. A received object is normally guaranteed to remain valid within the method it was received in. You use `retain` in two situations: (1) In the implementation of an accessor method (a setter) or to take ownership of an object; and (2) To prevent an object from being deallocated as a side-effect of some other operation.
3. *When you no longer need it, you must relinquish ownership of an object you own*. You relinquish ownership by calling its `release()` or `autorelease()` method.
4. *You must not relinquish ownership of an object you do not own*.
When an object's `retainCount` reaches `0`, the object is immediately deallocated. It is illegal to call methods on a deallocated object and it may lead to an application crash.
### AutoreleasePools and Objects
Several methods that create temporary objects in **metal-cpp** add them to an `AutoreleasePool` to help manage their lifetimes. In these situations, after **metal-cpp** creates the object, it adds it to an `AutoreleasePool`, which will release its objects when you release (or drain) it.
By adding temporary objects to an AutoreleasePool, you do not need to explicitly call `release()` to deallocate them. Instead, you can rely on the `AutoreleasePool` to implicitly manage those lifetimes.
If you create an object with a method that does not begin with `alloc`, `new`, `copy`, or `mutableCopy`, the creating method adds the object to an autorelease pool.
The typical scope of an `AutoreleasePool` is one frame of rendering for the main thread of the program. When the thread returns control to the RunLoop (an object responsible for receiving input and events from the windowing system), the pool is *drained*, releasing its objects.
You can create and manage additional `AutoreleasePool`s at smaller scopes to reduce your program's working set, and you are required to do so for any additional threads your program creates.
If an object's lifecycle needs to be extended beyond the `AutoreleasePool`'s scope, you can claim ownership of it (avoiding its release beyond the pool's scope) by calling its `retain()` method before its pool is drained. In these cases, you will be responsible for making the appropriate `release()` call on the object after you no longer need it.
You can find a more-detailed introduction to the memory management rules here: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/MemoryMgmt/Articles/mmRules.html.
For more details about the application's RunLoop, please find its documentation here: https://developer.apple.com/documentation/foundation/nsrunloop
### Use and debug AutoreleasePools
When you create an autoreleased object and there is no enclosing `AutoreleasePool`, the object is leaked.
To prevent this, you normally create an `AutoreleasePool` in your program's `main` function, and in the entry function for every thread you create. You may also create additional `AutoreleasePool`s to avoid growing your program's high memory watermark when you create several autoreleased objects, such as when rendering.
Use the Environment Variable `OBJC_DEBUG_MISSING_POOLS=YES` to print a runtime warning when an autoreleased object is leaked because no enclosing `AutoreleasePool` is available for its thread.
You can also run `leaks --autoreleasePools` on a memgraph file or a process ID (macOS only) to view a listing of your program's `AutoreleasePool`s and all objects they contain.
### nullptr
Similar to Objective-C, it is legal to call any method, including `retain()` and `release()`, on `nullptr` "objects". While calling methods on `nullptr` still does incur in function call overhead, the effective result is equivalent of a NOP.
Conversely, do not assume that because calling a method on a pointer did not result in a crash, that the pointed-to object is valid.
## Adding metal-cpp to a Project
Simply include `Metal/Metal.hpp`. To ensure that the selector and class symbols are linked, add to one of your cpp files:
```cpp
#define NS_PRIVATE_IMPLEMENTATION
#define MTL_PRIVATE_IMPLEMENTATION
#include "Metal/Metal.hpp"
```
If you want to use the QuartzCore wrapper, add:
```cpp
#define CA_PRIVATE_IMPLEMENTATION
#include "QuartzCore/QuartzCore.hpp"
```
## Generating a Single Header File
Purely optional: You can generate a single header file that contains all **metal-cpp** headers via:
```shell
./SingleHeader/MakeSingleHeader.py Foundation/Foundation.hpp QuartzCore/QuartzCore.hpp Metal/Metal.hpp
```
By default the generated header file will be written to `./SingleHeader/Metal.hpp`
## Examples
#### Creating the device
###### Objective-C (with automatic reference counting)
```objc
id< MTLDevice > device = MTLCreateSystemDefaultDevice();
// ...
```
###### Objective-C
```objc
id< MTLDevice > device = MTLCreateSystemDefaultDevice();
// ...
[device release];
```
###### C++
```cpp
MTL::Device* pDevice = MTL::CreateSystemDefaultDevice();
// ...
pDevice->release();
```
#### Metal function calls map directly to C++
###### Objective-C (with automatic reference counting)
```objc
MTLSamplerDescriptor* samplerDescriptor = [[MTLSamplerDescriptor alloc] init];
[samplerDescriptor setSAddressMode: MTLSamplerAddressModeRepeat];
[samplerDescriptor setTAddressMode: MTLSamplerAddressModeRepeat];
[samplerDescriptor setRAddressMode: MTLSamplerAddressModeRepeat];
[samplerDescriptor setMagFilter: MTLSamplerMinMagFilterLinear];
[samplerDescriptor setMinFilter: MTLSamplerMinMagFilterLinear];
[samplerDescriptor setMipFilter: MTLSamplerMipFilterLinear];
[samplerDescriptor setSupportArgumentBuffers: YES];
id< MTLSamplerState > samplerState = [device newSamplerStateWithDescriptor:samplerDescriptor];
```
###### Objective-C
```objc
MTLSamplerDescriptor* samplerDescriptor = [[MTLSamplerDescriptor alloc] init];
[samplerDescriptor setSAddressMode: MTLSamplerAddressModeRepeat];
[samplerDescriptor setTAddressMode: MTLSamplerAddressModeRepeat];
[samplerDescriptor setRAddressMode: MTLSamplerAddressModeRepeat];
[samplerDescriptor setMagFilter: MTLSamplerMinMagFilterLinear];
[samplerDescriptor setMinFilter: MTLSamplerMinMagFilterLinear];
[samplerDescriptor setMipFilter: MTLSamplerMipFilterLinear];
[samplerDescriptor setSupportArgumentBuffers: YES];
id< MTLSamplerState > samplerState = [device newSamplerStateWithDescriptor:samplerDescriptor];
[samplerDescriptor release];
// ...
[samplerState release];
```
###### C++
```cpp
MTL::SamplerDescriptor* pSamplerDescriptor = MTL::SamplerDescriptor::alloc()->init();
pSamplerDescriptor->setSAddressMode( MTL::SamplerAddressModeRepeat );
pSamplerDescriptor->setTAddressMode( MTL::SamplerAddressModeRepeat );
pSamplerDescriptor->setRAddressMode( MTL::SamplerAddressModeRepeat );
pSamplerDescriptor->setMagFilter( MTL::SamplerMinMagFilterLinear );
pSamplerDescriptor->setMinFilter( MTL::SamplerMinMagFilterLinear );
pSamplerDescriptor->setMipFilter( MTL::SamplerMipFilterLinear );
pSamplerDescriptor->setSupportArgumentBuffers( true );
MTL::SamplerState* pSamplerState = pDevice->newSamplerState( pSamplerDescriptor );
pSamplerDescriptor->release();
// ...
pSamplerState->release();
```
#### A subset of bindings for Foundation classes is provided for seamless integration
###### Objective-C (with automatic reference counting)
```objc
NSAutoreleasePool* pool = [[NSAutoreleasePool alloc] init];
NSString* string = [NSString stringWithCString: "Hello World" encoding: NSASCIIStringEncoding];
printf( "string = \"%s\"\n", [string cStringUsingEncoding: NSASCIIStringEncoding] );
```
###### Objective-C
```objc
NSAutoreleasePool* pool = [[NSAutoreleasePool alloc] init];
NSString* string = [NSString stringWithCString: "Hello World" encoding: NSASCIIStringEncoding];
printf( "string = \"%s\"\n", [string cStringUsingEncoding: NSASCIIStringEncoding] );
[pool release];
```
###### C++
```cpp
NS::AutoreleasePool* pPool = NS::AutoreleasePool::alloc()->init();
NS::String* pString = NS::String::string( "Hello World", NS::ASCIIStringEncoding );
printf( "pString = \"%s\"\n", pString->cString( NS::ASCIIStringEncoding ) );
pPool->release();
```
#### Interoperability with CoreFoundation
```cpp
MTL::AccelerationStructureTriangleGeometryDescriptor* pGeoDescriptor = MTL::AccelerationStructureTriangleGeometryDescriptor::alloc()->init();
CFTypeRef descriptors[] = { ( CFTypeRef )( pGeoDescriptor ) };
NS::Array* pGeoDescriptors = ( NS::Array* )( CFArrayCreate( kCFAllocatorDefault, descriptors, SIZEOF_ARRAY( descriptors), &kCFTypeArrayCallBacks ) );
// ...
pGeoDescriptors->release();
```
#### Accessing a CAMetalDrawable
```objc
#import <QuartzCore/CAMetalLayer.h>
#import <QuartzCore/QuartzCore.hpp>
// ...
CAMetalLayer* metalLayer = /* get your layer from your view */;
id< CAMetalDrawable > metalDrawable = [metalLayer nextDrawable];
CA::MetalDrawable* pMetalCppDrawable = ( __bridge CA::MetalDrawable* ) metalDrawable;
// ...
```

271
extern/metal-cpp/include/SingleHeader/MakeSingleHeader.py vendored
View file

@ -1,271 +0,0 @@
#!/usr/bin/python
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
#
# SingleHeader/MakeSingleHeader.py
#
# Copyright 2020-2021 Apple Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
import argparse
import datetime
import logging
import os
import re
import subprocess
import sys
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
class HeaderPrefix( object ):
__template = ( '//\n'
'// {file}\n'
'//\n'
'// {meta_data}\n'
'//\n'
'// Copyright 2020-2021 Apple Inc.\n'
'//\n'
'// Licensed under the Apache License, Version 2.0 (the "License");\n'
'// you may not use this file except in compliance with the License.\n'
'// You may obtain a copy of the License at\n'
'//\n'
'// http://www.apache.org/licenses/LICENSE-2.0\n'
'//\n'
'// Unless required by applicable law or agreed to in writing, software\n'
'// distributed under the License is distributed on an "AS IS" BASIS,\n'
'// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n'
'// See the License for the specific language governing permissions and\n'
'// limitations under the License.\n'
'//\n'
'\n' )
__template_commit = 'Autogenerated from commit {commit}.'
__template_date = 'Autogenerated on %B %d, %Y.'
def __init__( self, file ):
self.__file = file
def __str__( self ):
return self.__template.format( file = self.__file, meta_data = self.__meta_data_string() )
def __get_commit_hash( self ):
git_commit_hash = None
try:
git_dir = os.path.dirname( os.path.realpath( __file__ ) )
proc = subprocess.Popen( [ 'git', 'rev-parse', 'HEAD' ], cwd = git_dir, stdout = subprocess.PIPE, stderr = subprocess.PIPE )
git_commit_hash = proc.stdout.read().decode( 'utf-8', 'replace' ).strip()
except:
logging.error( 'Failed to determine git commit hash!' )
pass
return git_commit_hash
def __get_commit_string( self ):
meta_data = None
git_commit_hash = self.__get_commit_hash()
if git_commit_hash:
meta_data = self.__template_commit.format( commit = git_commit_hash )
return meta_data
def __get_date_string( self ):
today = datetime.date.today()
return today.strftime( self.__template_date )
def __meta_data_string( self ):
meta_data = self.__get_commit_string()
if not meta_data:
meta_data = self.__get_date_string()
return meta_data
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
class SingleHeader( object ):
__pragma_once = '#pragma once\n\n'
def __init__( self ):
self.__header_paths = list()
def __str__( self ):
return self.process()
def append( self, header_path ):
self.__header_paths.append( header_path )
def process( self ):
out_header = self.__pragma_once
self.__included_headers = set()
self.__base_path = list()
for header_path in self.__header_paths:
out_header += self.__process_header( header_path )
return self.__strip_empty_lines( out_header )
def __read_header( self, path ):
path = os.path.realpath( path )
try:
f = open( path, 'r' )
except:
raise RuntimeError( 'Failed to open file \"' + path + '\" for read!' )
return f.read()
def __strip_pragma_once( self, header ):
return re.sub( '\\s*#pragma once\s*\\/\\/-*\\n', '', header )
def __strip_comments( self, header ):
return re.sub( '^//.*\\n', '', header, flags = re.MULTILINE )
def __strip_empty_lines( self, header ):
return re.sub( '\\n\\n+', '\\n\\n', header, flags = re.MULTILINE )
def __substitute_include_directive( self, match ):
header_path = match.group( 'HEADER_PATH' )
logging.info( '\tSubstituting \"' + header_path + '\"...' )
return self.__process_header( os.path.join( self.__base_path[-1], header_path ) )
def __process_include_directives( self, header ):
return re.sub( '^\\s*#include\\s\\"(?P<HEADER_PATH>\\S*)\\"', self.__substitute_include_directive, header, flags = re.MULTILINE )
def __process_foundation_directives( self, header ):
if header.find("#include <Foundation/Foundation.hpp>") != -1:
logging.info( '\tSubstituting <Foundation/Foundation.hpp>...' )
return header.replace("#include <Foundation/Foundation.hpp>", self.__process_header( os.path.join( self.__base_path[-1], "../Foundation/Foundation.hpp" ) ) )
return header
def __process_header( self, header_path ):
out_header = ''
header_path = os.path.realpath( header_path )
if not header_path in self.__included_headers:
logging.info( 'Processing \"' + header_path + '\"...' )
self.__base_path.append( os.path.dirname( header_path ) )
self.__included_headers.add( header_path )
out_header = self.__read_header( header_path )
out_header = self.__strip_pragma_once( out_header )
out_header = self.__strip_comments( out_header )
out_header = self.__process_include_directives( out_header )
out_header = self.__process_foundation_directives( out_header )
self.__base_path.pop()
else:
logging.info( '\tSkipping \"' + header_path + '\"...' )
return out_header
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
def create_argument_parser():
parser = argparse.ArgumentParser()
base_path = os.path.dirname( os.path.realpath( __file__ ) )
output_path = os.path.join( base_path, 'Metal.hpp' )
parser.add_argument( '-o', '--output', dest = 'output_path', metavar = 'PATH', default = output_path, help = 'Output path for the single header file.' )
parser.add_argument( '-v', '--verbose', action = 'store_true', help = 'Show verbose output.' )
parser.add_argument( dest = 'header_paths', metavar = 'HEADER_FILE', nargs='+', help = 'Input header file.' )
return parser
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
def parse_arguments():
parser = create_argument_parser()
args = parser.parse_args()
if args.verbose:
logging.getLogger().setLevel( logging.INFO )
else:
logging.getLogger().setLevel( logging.ERROR )
return args
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
def make_header( args ):
prefix = HeaderPrefix( os.path.basename( args.output_path ) )
header = SingleHeader()
for header_path in args.header_paths:
header.append( header_path )
return str( prefix ) + str( header )
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
def make_dir( path ):
try:
if not os.path.exists( path ):
os.makedirs( path )
except os.error:
pass
except:
raise
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
def write_header( args, content ):
path = os.path.realpath( args.output_path )
logging.info( 'Writing \"' + path + '\"...' )
make_dir( os.path.dirname( path ) )
try:
f = open( path, 'w' )
except:
raise RuntimeError( 'Failed to open file \"' + path + '\" for write!' )
f.write( content )
#--------------------------------------------------------------------------------------------------------------------------------------------------------------
if __name__ == '__main__':
result = -1
try:
if sys.getdefaultencoding().lower() == 'ascii':
reload( sys )
sys.setdefaultencoding( 'utf-8' )
args = parse_arguments()
header = make_header( args )
write_header( args, header )
result = 0
except ( KeyboardInterrupt, SystemExit ):
pass
except:
raise
sys.exit( result )
#--------------------------------------------------------------------------------------------------------------------------------------------------------------