Classes

Enumerations

enums.FileTypes

makeprojects.enums.FileTypes : public IntEnum

Enumeration of supported file types for project input.

Each file that is to be added to a project has specific build rules, this enumeration helps determine which compiler to invoke to build the file if a build step is necessary.

Public Functions

__repr__(self)

Convert the enumeration into a human readable file description.

See also

makeprojects.enums._FILETYPES_READABLE

Parameters:: self – FileTypes instance
Returns:: Human readable string or None if the enumeration is invalid

__str__(self)

Convert the enumeration into a human readable file description.

See also

makeprojects.enums._FILETYPES_READABLE

Parameters:: self – FileTypes instance
Returns:: Human readable string or None if the enumeration is invalid

Public Static Functions

lookup(test_name)

Look up a file name extension and return the type.

Parse the filename extension and match it to a table of known extensions and return the enumeration for the file type. The test is case insensitive.

See also

makeprojects.enums._FILETYPES_LOOKUP

Parameters:: test_name – Filename to test
Returns:: A FileTypes member or None on failure

Public Static Attributes

user = 0: User file type (Unknown)

generic = 1: Non compiling file type.

c = 2: Compile as C.

cpp = 3: Compile as C++.

h = 4: C/C++ header.

m = 5: Objective-C.

mm = 6: Objective-C++.

xml = 7: XML text file.

rc = 8: Windows resource file.

r = 9: Mac OS resource file.

hlsl = 10: HLSL DirectX Shader.

glsl = 11: GLSL OpenGL Shader.

x360sl = 12: Xbox 360 DirectX Shader.

vitacg = 13: Playstation Vita CG Shader.

frameworks = 14: Mac OSX Framework.

library = 15: Static libary.

object = 16: Object code.

exe = 17: Executable file.

xcconfig = 18: XCode configuration file.

x86 = 19: X86 assembly source.

x64 = 20: X64 assembly source.

a65 = 21: 6502/65812 assembly source

ppc = 22: PowerPC assembly source.

a68 = 23: 680x0 assembly source

arm = 24: ARM 32 assembly source.

arm64 = 25: ARM 64 assembly source.

s = 26: Generic assembly source.

image = 27: Image files.

ico = 28: Windows icon files.

icns = 29: MacOSX icon files.

appxmanifest = 30: Windows AppXManifest files.

enums.IDETypes

makeprojects.enums.IDETypes : public IntEnum

Enumeration of supported IDEs.

All supported IDEs and makefile formats are enumerated here.

Public Functions

get_short_code(self)

Create the ide code from the ide type.

Return the three letter code that determines the specfic IDE version that the project file is meant for.

See also

makeprojects.enums._IDETYPES_CODES

Returns:: Three letter code specific to the IDE version or None.

is_visual_studio(self)

Determine if the IDE is Microsoft Visual Studio.

Returns:: True if the platform is Microsoft Visual Studio.

is_xcode(self)

Determine if the IDE is Apple XCode.

Returns:: True if the platform is Apple XCode.

is_codewarrior(self)

Determine if the IDE is Metrowerks / Freescale Codewarrior.

Returns:: True if the platform is Metrowerks / Freescale Codewarrior.

__repr__(self)

Convert the enumeration into a human readable file description.

See also

makeprojects.enums._IDETYPES_READABLE

Returns:: Human readable string or None if the enumeration is invalid

__str__(self)

Convert the enumeration into a human readable file description.

See also

makeprojects.enums._IDETYPES_READABLE

Returns:: Human readable string or None if the enumeration is invalid

Public Static Functions

lookup(ide_name)

Look up a IDETypes based on name.

For maximum compatiblity, the name will be scanned from several look up tables to attempt to cover all premutations of an input string.

Note

String comparisons are case insensitive.

Parameters:: ide_name – Platform string to test.
Returns:: A IDETypes member or None on failure.

default(): Determine the default IDETypes from the currently running platform.

Public Static Attributes

vs2003 = 0: Visual studio 2003.

vs2005 = 1: Visual studio 2005.

vs2008 = 2: Visual studio 2008.

vs2010 = 3: Visual studio 2010.

vs2012 = 4: Visual studio 2012.

vs2013 = 5: Visual studio 2013.

vs2015 = 6: Visual studio 2015.

vs2017 = 7: Visual studio 2017.

vs2019 = 8: Visual studio 2019.

vs2022 = 9: Visual studio 2022.

watcom = 10: Open Watcom 1.9 or later.

codewarrior50 = 11: Metrowerks Codewarrior 9 / 5.0 (Windows/Mac OS)

codewarrior58 = 12: Metrowerks Codewarrior 10 / 5.8 (Mac OS Carbon)

codewarrior59 = 13: Freescale Codewarrior 5.9 (Nintendo DSi)

xcode3 = 14: XCode 3 (PowerPC 3.1.4 is the target version)

xcode4 = 15: XCode 4.

xcode5 = 16: XCode 5.

xcode6 = 17: XCode 6.

xcode7 = 18: XCode 7.

xcode8 = 19: XCode 8.

xcode9 = 20: XCode 9.

xcode10 = 21: XCode 10.

xcode11 = 22: XCode 11.

xcode12 = 23: XCode 12.

xcode13 = 24: XCode 13.

xcode14 = 25: XCode 14.

xcode15 = 26: XCode 15.

xcode16 = 27: XCode 16.

codeblocks = 28: Codeblocks.

nmake = 29: nmake

make = 30: Linux/GNU make.

bazel = 31: Bazel build.

mpw = 32: Apple MPW.

buck = 33: Buck builder.

ninja = 34: Google ninja.

enums.PlatformTypes

makeprojects.enums.PlatformTypes : public IntEnum

Enumeration of supported target platforms.

All supported tool chains for specific platforms are enumerated here.

Public Functions

get_short_code(self)

Convert the enumeration to a 3 letter code for filename suffix.

Create a three letter code for the target platform for the final filename for the project. For platforms that support multiple CPU architectures, the code will be six letters long with the CPU appended to the three letter platform code.

See also

makeprojects.enums._PLATFORMTYPES_CODES

Returns:: A three or six letter code for the platform.

is_windows(self)

Determine if the platform is windows.

Returns:: True if the platform is for Microsoft windows.

is_xbox(self)

Determine if the platform is a version of the Xbox.

Returns:: True if the platform is for Xbox, Xbox 360, or Xbox ONE.

is_xboxone(self)

Determine if the platform is a version of the Xbox ONE.

Returns:: True if the platform is for Xbox ONE.

is_microsoft(self)

Determine if the platform is a Microsoft platform.

Returns:: True if the platform is for Xbox, or Windows.

is_macosx(self)

Determine if the platform is macOS.

Returns:: True if the platform is Apple macOS.

is_ios(self)

Determine if the platform is iOS.

Returns:: True if the platform is Apple iOS.

is_darwin(self)

Determine if the platform supports Darwin.

Returns:: True if the platform is Apple iOS or macOS X.

is_macos(self)

Determine if the platform is MacOS classic or Carbon.

Returns:: True if Apple MacOS 1.0 through 9.2.2 or the Carbon API.

is_macos_68k(self)

Determine if the platform is MacOS 68K.

Returns:: True if Apple MacOS 1.0 through 8.1 using the 68k processor

is_macos_ppc(self)

Determine if the platform is MacOS PowerPC.

Returns:: True if Apple MacOS 7.0 through 9.2.2 using the PowerPC processor

is_macos_carbon(self)

Determine if the platform is MacOS Carbon.

Returns:: True if the platform is Apple MacOS Carbon API.

is_macos_classic(self)

Determine if the platform is MacOS classic (MacOS 1.0 to 9.2.2).

Returns:: True if the platform is Apple MacOS 1.0 through 9.2.2.

is_msdos(self)

Determine if the platform is MSDos.

Returns:: True if the platform is MSDos

is_android(self)

Determine if the platform is Android.

Returns:: True if the platform is Android

is_switch(self)

Determine if the platform is Nintendo Switch.

Returns:: True if the platform is Nintendo Switch

is_nintendo(self)

Determine if the platform is from Nintendo.

Returns:: True if it’s a Nintendo platform

is_sony(self)

Determine if it is a Sony platform.

Returns:: True if the platform is one from Sony

get_platform_folder(self)

Return the name of a folder that would hold platform specific files.

Returns:: String of the name of the folder name, or None if not found.

match(self, second)

Test if two platform types are a match.

If two platform types are similar, this function will return True. An example would be a windows 32 bit and a windows 64 bit platform would match.

Returns:: True if the types are compatible.

get_vs_platform(self)

Create the platform codes from the platform type for Visual Studio.

Visual Studio uses specific codes for tool chains used for video game consoles or CPUs. This function returns a list of codes needed to support the requested platform.

See also

makeprojects.enums._PLATFORMTYPES_VS

Returns:: A list of Visual Studio platforms for target.

get_expanded(self)

Return a list of platforms from a platform that is a group.

Returns:: A tuple of PlatformTypes

is_expandable(self)

Return True if the platform defines other platforms.

Returns:

True or False

__repr__(self)

Convert the enumeration into a human readable file description.

Returns:: Human readable string or None if the enumeration is invalid

__str__(self)

Convert the enumeration into a human readable file description.

Returns:: Human readable string or None if the enumeration is invalid

Public Static Functions

lookup(platform_name)

Look up a PlatformType based on name.

For maximum compatiblity, the name will be scanned from several look up tables to attempt to cover all premutations of an input string.

Note

String comparisons are case insensitive.

Parameters:: platform_name – Platform string to test.
Returns:: A PlatformTypes member or None on failure.

default()

Determine the PlatformTypes from the currently running platform.

Returns:: PlatformTypes.windows, PlatformTypes.macosx, or PlatformTypes.linux

Public Static Attributes

msdos = 0: MSDOS.

msdos4gw = 1: MSDOS Dos4GW.

msdosx32 = 2: MSDOS DosX32.

beos = 3: BeOS.

iigs = 4: Apple IIgs.

xbox = 5: Microsoft Xbox classic.

xbox360 = 6: Microsoft Xbox 360.

xboxone = 7: Microsoft Xbox ONE.

xboxgdk = 8: Microsoft Xbox ONE GDK.

xboxonex = 9: Microsoft Xbox ONE Series X GDK.

ps1 = 10: Sony PS1.

ps2 = 11: Sony PS2.

ps3 = 12: Sony PS3.

ps4 = 13: Sony PS4.

ps5 = 14: Sony PS5.

psp = 15: Sony Playstation portable.

vita = 16: Sony Playstation VITA.

wii = 17: Nintendi Wii.

wiiu = 18: Nintendo WiiU.

switch = 19: Nintendo Switch.

switch32 = 20: Nintendo Switch 32 bit only.

switch64 = 21: Nintendo Switch 64 bit only.

dsi = 22: Nintendo 3DS.

ds = 23: Nintendo DS.

windows = 24: Windows 32 and 64 bit Intel and arm64.

windowsintel = 25: Windows 32 and 64 bit Intel.

windowsarm = 26: Windows 32 and 64 bit arm.

win32 = 27: Windows 32 bit intel only.

win64 = 28: Window 64 bit intel only.

winarm32 = 29: Windows 32 bit arm only.

winarm64 = 30: Windows 64 bit arm only.

winitanium = 31: Windows 64 bit itanium only.

macosx = 32: Mac OSX, all CPUs.

macosxppc32 = 33: Mac OSX PowerPC 32 bit only.

macosxppc64 = 34: Mac OSX PowerPC 64 bit only.

macosxintel32 = 35: Mac OSX Intel 32 bit only.

macosxintel64 = 36: Mac OSX Intel 64 bit only.

macosxarm64 = 37: Mac OSX ARM 64 bit only.

ios = 38: iOS, all CPUs

iosemu = 39: iOS emulator, all CPUs

ios32 = 40: iOS 32 bit ARM only

ios64 = 41: iOS 64 bit ARM only

iosemu32 = 42: iOS emulator 32 bit Intel only

iosemu64 = 43: iOS emulator 64 bit Intel only

mac = 44: Mac OS 7-9, all CPUs.

mac68k = 45: Mac OS 7-9 680x0 only.

macppc = 46: Mac OS 7-9 PowerPC 32 bit only.

macclassic = 47: Mac OS 7-9, 68k and PPC.

maccarbon = 48: Mac OS Carbon, all CPUs.

mac68knear = 49: Mac OS Classic 680x0 only (near)

mac68knearfp = 50: Mac OS Classic 680x0 only (near with fpu)

mac68kfar = 51: Mac OS Classic 680x0 only (far)

mac68kfarfp = 52: Mac OS Classic 680x0 only (far with fpu)

mac68kcarbon = 53: Mac OS Carbon 680x0 only (CFM)

macppcclassic = 54: Mac OS Classic PowerPC 32 bit only.

macppccarbon = 55: Mac OS Carbon PowerPC 32 bit only.

stadia = 56: Google Stadia.

android = 57: Generic Android.

shield = 58: nVidia SHIELD

amico = 59: Intellivision Amico.

ouya = 60: Ouya (Now Razor)

tegra = 61: Android Tegra.

androidarm32 = 62: Android Arm32.

androidarm64 = 63: Android Arm64.

androidintel32 = 64: Android Intel x32.

androidintel64 = 65: Android Intel / AMD 64.

linux = 66: Generic Linux.

enums.ProjectTypes

makeprojects.enums.ProjectTypes : public IntEnum

Enumeration of supported project types.

Each configuration can build a specific type of file, this enumeration lists out the types of files that can be built.

Public Functions

is_library(self)

Determine if the project is a library.

Returns:: True if the project is a static or dynamic library.

__repr__(self)

Convert the enumeration into a human readable file description.

Returns:: Human readable string or None if the enumeration is invalid

__str__(self)

Convert the enumeration into a human readable file description.

Returns:: Human readable string or None if the enumeration is invalid

Public Static Functions

lookup(project_type_name)

Look up a ProjectTypes based on name.

For maximum compatiblity, the name will be scanned from several look up tables to attempt to cover all premutations of an input string.

Note

String comparisons are case insensitive.

Parameters:: project_type_name – Project type string to test.
Returns:: A ProjectTypes member or None on failure.

default(): Determine the ProjectTypes default.

Public Static Attributes

library = 0: Code library.

tool = 1: Command line tool.

app = 2: Application.

screensaver = 3: Screen saver.

sharedlibrary = 4: Shared library (DLL)

empty = 5: Empty project.

Project Classes

core.Attributes

Warning

doxygenclass: Cannot find class “makeprojects::core::Attributes” in doxygen xml output for project “makeprojects” from directory: temp/xml/

core.SourceFile

Warning

doxygenclass: Cannot find class “makeprojects::core::SourceFile” in doxygen xml output for project “makeprojects” from directory: temp/xml/

core.Configuration

Warning

doxygenclass: Cannot find class “makeprojects::core::Configuration” in doxygen xml output for project “makeprojects” from directory: temp/xml/

core.Project

Warning

doxygenclass: Cannot find class “makeprojects::core::Project” in doxygen xml output for project “makeprojects” from directory: temp/xml/

core.Solution

Warning

doxygenclass: Cannot find class “makeprojects::core::Solution” in doxygen xml output for project “makeprojects” from directory: temp/xml/

Build Classes

build_objects.BuildError

class BuildError

Error message generated by builders.

When a builder completes, a BuildError class is created and appended to the results list for logging.

Public Functions

__init__(self, error, filename, configuration=None, msg=None)

Initializers for an BuildError.

Parameters:

error – Integer error code, zero if not error
filename – File that generated the error
configuration – If applicable, configuration that was compiled
msg – Error message test, if available

get_error_code(self)

Return the integer error code.

Returns:: The integer error code.

__repr__(self)

Convert the error into a string.

Returns:: A full error string.

__str__(self)

Convert the error into a string.

Returns:: A full error string.

Public Members

error = error: Integer error code.

filename = filename: File name that generated the error.

configuration = configuration: Build configuration.

msg = msg: Error message.

build_objects.BuildObject

class BuildObject

Object describing something to build.

When the directory is parsed, a list of BuildObjects is generated and then sorted by priority and then built.

Subclassed by makeprojects.codeblocks.BuildCodeBlocksFile, makeprojects.codewarrior.BuildCodeWarriorFile, makeprojects.doxygen.BuildDoxygenFile, makeprojects.makefile.BuildMakeFile, makeprojects.makerez.BuildRezFile, makeprojects.ninja.BuildNinjaFile, makeprojects.python.BuildPythonFile, makeprojects.slicer.BuildSlicerFile, makeprojects.visual_studio.BuildVisualStudioFile, makeprojects.watcom.BuildWatcomFile, makeprojects.xcode.BuildXCodeFile

Public Functions

__init__(self, file_name, priority=None, configuration=None)

Initializers for an BuildObject.

Parameters:

file_name – Name of the file to build.
priority – Integer priority, lower will be built first.
configuration – Configuration to build

Throws TypeError:

Throws ValueError:

build(self)

Perform the build operation.

Returns:: BuildError object as Unimplemented build.

clean(self)

Delete temporary files.

This function is called by cleanme to remove temporary files.

On exit, return 0 for no error, or a non zero error code if there was an error to report. None if not implemented or not applicable.

Returns:: None if not implemented, otherwise an integer error code.

run_command(self, cmd, verbose)

Issue a command and return the generated BuildError.

Parameters:

cmd – command line to execute
verbose – True if verbose output is required

Returns:

BuildError object with error condition, if any.

__repr__(self)

Convert the object into a string.

Returns:: A full string.

__str__(self)

Convert the object into a string.

Returns:: A full string.

Public Members

file_name = os.path.abspath(file_name): Name of file to build.

priority = int(priority): Numeric priorty in ascending order.

configuration = configuration: Configuration if applicable.

Validators

validators.VSBooleanProperty

class VSBooleanProperty

Value can only be true or false.

Public Functions

__init__(self, name, fallback=None)

Initialize the default value.

Parameters:

name – Name of the validator
fallback – Default value, None is acceptable

get_value(self): Return the string representation of the string, or None.

__repr__(self)

Convert to string.

Returns:: “true”, “false” or “None”

__str__(self)

Convert to string.

Returns:: “true”, “false” or “None”

Public Members

name = name: Name of the validator.

Public Static Functions

validate(key, configuration, fallback=None, options_key=None, options=None)

Check if there is a command line switch override.

Given a configuration, scan for the options_key and if found, check if that list has one of the option tuples. If there’s a match, use the options tuple entry, otherwise use the fallback value.

Parameters:

key – Name of the XML attribute key
configuration – configuration to scan for an override
fallback – Value to use in case there is no override.
options_key – Attribute to scan for commmand line options
options – Iterable with options / Value pairs

Returns:

None or VSBooleanProperty instance

vs_validate(key, configuration, fallback=None, options_key=None, options=None, prefix=None)

Check if there is an override with a vs_ prefix.

Check if the configuration has a key of “vs_” + prefix + key in the configuration and if not found or None, use the key as is.

Parameters:

key – Name of the XML attribute key
configuration – configuration to scan for an override
fallback – Value to use in case there is no override.
options_key – Attribute to scan for commmand line options
options – Iterable with options / Value pairs
prefix – String to insert after “vs_”

Returns:

None or VSBooleanProperty instance

Public Static Attributes

value = BooleanProperty("_value"): BooleanProperty boolean value.

validators.VSIntegerProperty

class VSIntegerProperty

Value can only be integer or None.

Public Functions

__init__(self, name, fallback=None)

Initialize the default values.

Set the name (Required), value and compiler switch.

Parameters:

name – Name of the validator
fallback – Default value, None is acceptable

get_value(self)

Return the string representation of the integer, or None.

Returns:: String of number or None

__repr__(self)

Convert to string.

Returns:: Value as a string or “None”

__str__(self)

Convert to string.

Returns:: Value as a string or “None”

Public Members

name = name: Name of the validator.

Public Static Functions

vs_validate(key, configuration, fallback=None, prefix=None)

Check if there is an override with a vs_ prefix.

Check if the configuration has a key of “vs_” + prefix + key in the configuration and if not found or None, use the fallback as is.

Parameters:

key – Name of the XML attribute key
configuration – configuration to scan for an override
fallback – Value to use in case there is no override.
prefix – String to insert after “vs_”

Returns:

VSIntegerProperty instance

Public Static Attributes

value = IntegerProperty("_value"): Integer value.

validators.VSStringProperty

class VSStringProperty

Value can be any string.

Public Functions

__init__(self, name, fallback=None)

Initialize the default value.

Parameters:

name – Name of the validator
fallback – Default value, None is acceptable

get_value(self): Return the string representation of the string, or None.

__repr__(self)

Convert to string.

Returns:: Value as a string

__str__(self)

Convert to string.

Returns:: Value as a string

Public Members

name = name: Name of the validator.

Public Static Functions

vs_validate(key, configuration, fallback=None, prefix=None)

Check if there is an override with a vs_ prefix.

Check if the configuration has a key of “vs_” + prefix + key in the configuration and if not found or None, use the fallback as is.

Parameters:

key – Name of the XML attribute key
configuration – configuration to scan for an override
fallback – Value to use in case there is no override.
prefix – String to insert after “vs_”

Returns:

VSStringProperty instance

Public Static Attributes

value = StringProperty("_value"): String value.

validators.VSStringListProperty

class VSStringListProperty

List of strings or directories.

Public Functions

__init__(self, name, fallback, slashes=None, separator=None, force_ending_slash=False)

Initialize the default value.

Parameters:

name – Name of the validator
fallback – Default value, None is acceptable
slashes – “/” or ‘' or None for no conversion
separator – Character to use to seperate entries, “;” for None
force_ending_slash – Enforce a trailing slash if True

set_value(self, value)

Update the value with a string.

Value can be a boolean, a number, a string or None to set to default.

Parameters:: value – None, bool, number, or string.

get_value(self): Return the string representation of the string, or None.

__repr__(self)

Convert to string.

Returns:: Value as a string

__str__(self)

Convert to string.

Returns:: Value as a string

Public Members

name = name: Name of the validator.

default = fallback: Default values of the validator.

slashes = slashes: Slashes for directory.

separator = separator: Seperator character instead of “;”.

force_ending_slash = force_ending_slash: True if an endling slash is needed for a directory.

Public Static Attributes

value = StringListProperty("_value"): String list value.

validators.VSEnumProperty

class VSEnumProperty

Enumeration integer value.

Public Functions

__init__(self, name, fallback, enumerations)

Initialize the default value.

Parameters:

name – Name of the validator
fallback – Default value, None is acceptable
enumerations – List of enumeration alias tuples.

set_value(self, value)

Update with an index or an enumeration string.

Value can be a number, a string or None to set to default.

Except: ValueError on input error

Parameters:: value – None, number, or string.

get_value(self): Return the string representation of the string, or None.

__repr__(self)

Convert to string.

Returns:: Value as a string

__str__(self)

Convert to string.

Returns:: Value as a string

Public Members

name = name: Name of the validator.

default = fallback: Default value of the validator.

value = None: Active value.

enumerations = enumerations: Enumeration alias list.

Visual Studio

visual_studio.BuildVisualStudioFile

makeprojects.visual_studio.BuildVisualStudioFile : public makeprojects.build_objects.BuildObject

Class to build Visual Studio files.

This builds files from Visual Studio 2003-2022.

Public Functions

__init__(self, file_name, priority, configuration, verbose=False, vs_version=0)

Class to handle Visual Studio solution files.

Parameters:

file_name – Pathname to the *.sln to build
priority – Priority to build this object
configuration – Build configuration
verbose – True if verbose output
vs_version – Integer Visual Studio version

build_clean(self, build=True)

Build or clean a visual studio .sln file.

Supports Visual Studio 2003 - 2022. Supports platforms Win32, x64, Android, nVidia Tegra, PS3, ORBIS, PSP, PSVita, Xbox, Xbox 360, Xbox ONE, Switch, Wii

See also

parse_sln_file

Parameters:: build – If true, build, otherwise clean
Returns:: List of BuildError objects

build(self)

Build a visual studio .sln file.

Supports Visual Studio 2003 - 2022. Supports platforms Win32, x64, Android, nVidia Tegra, PS3, ORBIS, PSP, PSVita, Xbox, Xbox 360, Xbox ONE, Switch, Wii

See also

parse_sln_file

Returns:: List of BuildError objects

clean(self)

Delete temporary files.

This function is called by cleanme to remove temporary files.

On exit, return 0 for no error, or a non zero error code if there was an error to report. None if not implemented or not applicable.

Returns:: None if not implemented, otherwise an integer error code.

Public Members

verbose = verbose: The verbose flag.

vs_version = vs_version: The required version of Visual Studio.

visual_studio.VS2003XML

class VS2003XML

Visual Studio 2003-2008 XML formatter.

Output XML elements in the format of Visual Studio 2003-2008.

Visual Studio 2003-2008 only supports XML tags and attributes. There is no support for text between tags.

Theses are examples of XML fragments this class exports.

<Platforms>
    <Platform
        Name="Win32"/>
</Platforms>

<Tool
    Name="VCMIDLTool"/>

<-- force_pair disables support for "/>" closure -->
<File
    RelativePath=".\\source\\Win32Console.cpp">
</File>

Subclassed by makeprojects.visual_studio.VS2003Configuration, makeprojects.visual_studio.VS2003Configurations, makeprojects.visual_studio.VS2003File, makeprojects.visual_studio.VS2003FileConfiguration, makeprojects.visual_studio.VS2003Files, makeprojects.visual_studio.VS2003Filter, makeprojects.visual_studio.VS2003Globals, makeprojects.visual_studio.VS2003Platform, makeprojects.visual_studio.VS2003Platforms, makeprojects.visual_studio.VS2003References, makeprojects.visual_studio.VS2003Tool, makeprojects.visual_studio.VS2003ToolFile, makeprojects.visual_studio.VS2003ToolFiles, makeprojects.visual_studio.VS2003vcproj

Public Functions

__init__(self, name, attributes=None, force_pair=False)

Set the defaults.

Parameters:

name – Name of the XML element
attributes – dict of attributes to use as defaults.
force_pair – If True, disable the use of /> XML suffix usage.

add_attribute(self, attribute)

Add an attribute object.

Append the passed attribute to the end of the attribute list for this XML element.

Parameters:: attribute – A validator class instance

add_attributes(self, attributes)

Add a list of attribute objects.

Iterate over the list of attribute objects and append them to the end of the attribute list.

Parameters:: attributes – list of attribute objects.

add_element(self, element)

Add an element to this XML element.

Parameters:: element – VS2003XML object

set_attribute(self, name, value)

Change existing attribute.

If the attribute was not found, it will throw.

Parameters:

name – String of the entry to match
value – Value to substitute

remove_attribute(self, name)

Remove an attribute.

If the value is in the list, remove it.

Parameters:: name – String of the entry to remove
Returns:: True if found and removed, False if not present.

reset_attribute(self, name)

Reset an attribute to default.

If the attribute is in the attribute_defaults list, set it to the default, which can include the attribute removal.

Parameters:: name – String of the entry to reset

generate(self, line_list=None, indent=0, ide=None)

Generate the text lines for this XML element.

There is a slight difference between Visual Studio 2003 and 2005/2008 on how tags are closed. The argument ide is used to flag with close format to use.

Parameters:

line_list – list object to have text lines appended to
indent – number of tabs to insert (For recursion)
ide – IDE to target.

Returns:

line_list with all lines appended to it.

__repr__(self)

Convert the solution record into a human readable description.

Returns:: Human readable string or None if the solution is invalid

__str__(self)

Convert the solultion record into a human readable description.

Returns:: Human readable string or None if the solution is invalid

Public Members

name = name: Name of this XML chunk.

force_pair = force_pair: Disable <foo/> syntax.

elements = []: List of elements in this element.

attributes = []: List of valid attributes and defaults.

visual_studio.VS2003Tool

makeprojects.visual_studio.VS2003Tool : public makeprojects.visual_studio.VS2003XML

Helper class to output a Tool record for Visual Studio 2003-2008.

In Visual Studio project files from version 2003 to 2008, Tool XML records were used for settings for each and every compiler tool

Subclassed by makeprojects.visual_studio.VCALinkTool, makeprojects.visual_studio.VCAppVerifierTool, makeprojects.visual_studio.VCAuxiliaryManagedWrapperGeneratorTool, makeprojects.visual_studio.VCBscMakeTool, makeprojects.visual_studio.VCCLCompilerTool, makeprojects.visual_studio.VCCLCompilerToolFile, makeprojects.visual_studio.VCCustomBuildTool, makeprojects.visual_studio.VCFxCopTool, makeprojects.visual_studio.VCGLSLTool, makeprojects.visual_studio.VCHLSLTool, makeprojects.visual_studio.VCLibrarianTool, makeprojects.visual_studio.VCLinkerTool, makeprojects.visual_studio.VCMASM64Tool, makeprojects.visual_studio.VCMASMTool, makeprojects.visual_studio.VCMIDLTool, makeprojects.visual_studio.VCManagedResourceCompilerTool, makeprojects.visual_studio.VCManagedWrapperGeneratorTool, makeprojects.visual_studio.VCManifestTool, makeprojects.visual_studio.VCPostBuildEventTool, makeprojects.visual_studio.VCPreBuildEventTool, makeprojects.visual_studio.VCPreLinkEventTool, makeprojects.visual_studio.VCResourceCompilerTool, makeprojects.visual_studio.VCWebDeploymentTool, makeprojects.visual_studio.VCWebServiceProxyGeneratorTool, makeprojects.visual_studio.VCXDCMakeTool, makeprojects.visual_studio.VCXMLDataGeneratorTool, makeprojects.visual_studio.XboxDeploymentTool, makeprojects.visual_studio.XboxImageTool

Public Functions

__init__(self, name, force_pair=False)

Init a tool record with the tool name.

Parameters:

name – Name of the tool.
force_pair – If True, disable the use of /> XML suffix usage.

visual_studio.VCCLCompilerTool

makeprojects.visual_studio.VCCLCompilerTool : public makeprojects.visual_studio.VS2003Tool

Visual Studio 2003-2008 VCCLCompilerTool record.

Public Functions

__init__(self, configuration)

Init defaults.

Parameters:: configuration – Configuration record to extract defaults.

Public Members

configuration = configuration: Parent configuration.

visual_studio.VCCLCompilerToolFile

makeprojects.visual_studio.VCCLCompilerToolFile : public makeprojects.visual_studio.VS2003Tool

Visual Studio 2003-2008 VCCLCompilerTool record for file.

Public Functions

__init__(self, configuration)

Init defaults.

Parameters:: configuration – Configuration record to extract defaults.

Public Members

configuration = configuration: Parent configuration.

Watcom

watcom.BuildWatcomFile

makeprojects.watcom.BuildWatcomFile : public makeprojects.build_objects.BuildObject

Class to build watcom make files.

Public Functions

__init__(self, file_name, priority, configuration, verbose=False)

Class to handle watcom make files.

Parameters:

file_name – Pathname to the *.wmk to build
priority – Priority to build this object
configuration – Build configuration
verbose – True if verbose output

build(self)

Build Watcom MakeFile.

On Linux and Windows hosts, this function will invoke the wmake tool to build the watcom make file.

The PATH will be temporarily adjusted to include the watcom tools so wmake can find its shared libraries.

The default target built is all.

Returns:: List of BuildError objects

clean(self)

Delete temporary files.

This function is called by cleanme to remove temporary files.

On exit, return 0 for no error, or a non zero error code if there was an error to report. None if not implemented or not applicable.

Returns:: None if not implemented, otherwise an integer error code.

Public Members

verbose = verbose: Save the verbose flag.

watcom.WatcomProject

class WatcomProject

Root object for a Watcom IDE project file.

Created with the name of the project, the IDE code the platform code (4gw, x32, win)

Public Functions

__init__(self, solution)

Initialize the exporter.

Parameters:: solution – Parent solution.

write_header(self, line_list)

Write the header for a Watcom wmake file.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_test_variables(self, line_list)

Create tests for environment variables.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_extensions(self, line_list)

Write the list of acceptable file extensions.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_include_dlls(self, line_list)

Write the commands to include the DLLs for wmake.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_output_list(self, line_list)

Output the list of object files to create.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_all_targets(self, line_list)

Output all of the .SYMBOLIC targets.

Create all of the targets, starting with all, and then all the configurations, followed by the clean targets.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero.

write_directory_targets(self, line_list)

Create directory and make file targets.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_configurations(self, line_list)

Write configuration list.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_source_dir(self, line_list)

Write out the list of directories for the source.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_rules(self, line_list)

Output the default rules for building object code.

Parameters:: line_list – List of lines of text generated.
Returns:
Returns:: Zero

write_files(self, line_list)

Output the list of object files to create.

Parameters:: line_list – List of lines of text generated.
Returns:: True if compilable files were found

write_res_files(self, line_list)

Output the list of resource files to create.

Parameters:: line_list – List of lines of text generated.
Returns:: True if .rc files were found

write_custom_files(self, line_list)

Output the list of object files to create.

Parameters:: line_list – XList of lines of text generated.
Returns:
Returns:: Zero.

write_builds(self, line_list, has_rez)

Output the rule to build the exes/libs.

Parameters:

line_list – List of lines of text generated.
has_rez – Is there a Windows Resource file to link in

Returns:

Zero

generate(self, line_list=None)

Write out the watcom make project.

Parameters:: line_list – string list to save the XML text
Returns:: Zero on no error, non-zero on error.

Public Members

solution = solution: Parent solution.

platforms = platforms: List of all platform types.

configuration_list = []: List of all configurations.

configuration_names = []: List of configuration names.

custom_list = custom_list: List of custom built files.

output_list = get_output_list(custom_list): List of custom output files.