from __future__ import unicode_literals
from __future__ import print_function
from __future__ import division
from __future__ import absolute_import
from builtins import int
from builtins import next
from builtins import str
from builtins import object
from future import standard_library
from collections import OrderedDict
standard_library.install_aliases()
import warnings
warnings.warn(
"fgd-tools is deprecated, development is continued at https://github.com/pySourceSDK/ValveFGD")
[docs]class Fgd(object):
"""Contains all the data from a Fgd file such as
entities and other editor informations."""
[docs] def __init__(self):
"""Creates an empty instance of Fgd."""
self._includes = []
self._entities = []
self._editor_data = []
[docs] def __repr__(self):
"""A partial, printable summary of a Fgd.
:returns: A Python formated string.
:rtype: str
"""
return "<Fgd {'includes': [" + str(len(self.includes)) + '], ' + \
"'entities': [" + str(len(self.entities)) + '], ' + \
"'editor_data': [" + str(len(self.editor_data)) + ']}>'
@property
def includes(self):
"""A list of included :class:`fgdtools.Fgd`,
including inherited includes from @includes."""
parent_includes = [i.includes for i in self._includes]
parent_includes = [f for i in parent_includes for f in i]
return parent_includes + self._includes
@property
def entities(self):
"""A list containing all :class:`fgdtools.FgdEntity`,
including inherited entities from @includes."""
parent_entities = [i.entities for i in self._includes]
parent_entities = [e for i in parent_entities for e in i]
return parent_entities + self._entities
@property
def editor_data(self):
"""A list containing all :class:`fgdtools.FgdEditorData`,
including inherited data from @includes."""
parent_data = [i.editor_data for i in self._includes]
parent_data = [d for i in parent_data for d in i]
return parent_data + self._editor_data
[docs] def add_include(self, parent_fgd):
"""Adds a parent :class:`fgdtools.Fgd` to supplement this one.
:param parent_fgd: The Fgd object to be added as a parent.
:type parent_fgd: Fgd
"""
if not parent_fgd:
return
self._includes.append(parent_fgd)
[docs] def add_entity(self, fgd_entity):
"""Adds an entity to the Fgd.
:param fgd_entity: The FgdEntity object to be added
to this Fgd instance.
:type fgd_entity: FgdEntity
"""
if not fgd_entity:
return
# find parents
if fgd_entity.definitions:
for definition in fgd_entity.definitions:
if 'args' not in definition or \
'name' not in definition or \
definition['name'] != 'base':
continue
for entity_name in definition['args']:
try:
parent = self.entity_by_name(entity_name)
if parent and parent.name != fgd_entity.name:
fgd_entity._parents.append(parent)
except EntityNotFound:
pass
self._entities.append(fgd_entity)
[docs] def add_editor_data(self, fgd_editor_data):
"""Adds editor data to the Fgd.
:param fgd_editor_data: The FgdEditorData object to be added
to this Fgd instance.
:type fgd_editor_data: FgdEditorData
"""
if not fgd_editor_data:
return
self._editor_data.append(fgd_editor_data)
[docs] def entity_by_name(self, entity_name):
"""Finds an entity by its name.
:param entity_name: The entity name to look for.
:type entity_name: str
:raises EntityNotFound: Whenever an entity could not be found.
:return: An entity with matching name.
:rtype: FgdEntity
"""
result = next((c for c in self.entities if isinstance(
c, FgdEntity) and c.name == entity_name), None)
if not result:
raise EntityNotFound
return result
[docs] def fgd_str(self, collapse=False):
"""A string representation of the Fgd formated as in the a .fgd file.
:param collapse: If True, the content of included fgds will be included
in the output and @include statements will be removed.
If False, Include statements will be in the output
and the content of other Fgds will not be present.
:type collapse: bool
:return: Fgd formated string.
:rtype: str
"""
fgd_str = ''
if collapse:
for d in self.editor_data:
if d.class_type == 'include':
continue
fgd_str += d.fgd_str() + '\n\n'
for e in self.entities:
fgd_str += e.fgd_str() + '\n\n'
else:
for d in self._editor_data:
fgd_str += d.fgd_str() + '\n\n'
for e in self._entities:
fgd_str += e.fgd_str() + '\n\n'
return fgd_str
[docs]class FgdEditorData(object):
"""Editor data, as represented in a Fgd file. Usually of types such as:
@include, @mapsize, @MaterialExclusion or @AutoVisGroup.
"""
[docs] def __init__(self, class_type, data=None, name=None):
"""Creates an instance of FgdEditorData.
:param class_type: The editor_data's type.
Ex: 'mapsize', 'MaterialExclusion',
'AutoVisGroup', etc...
:type class_type: str
:param name: The editor_data's display name.
:type name: str
:param data: The editor_data's data.
:type data: str or tuple or list or dict
"""
self._class_type = class_type
self._name = name
self._data = data
[docs] def __repr__(self):
"""A partial, printable summary of a FgdEditorData.
:returns: A Python formated string.
:rtype: str
"""
return '<FgdEditorData of type ' + repr(self._class_type) + \
(' named ' + repr(self._name) if self._name else '') + ', [...]>'
@property
def class_type(self):
"""The editor_data's type.
:rtype: str"""
return self._class_type
@property
def name(self):
"""The editor_data's name.
:rtype: str"""
return self._name
@property
def data(self):
"""The editor_data's data, in the type that best matches class_type.
:rtype: str or tuple or list or dict"""
return self._data
[docs] def fgd_str(self):
"""A string representation of FgdEditorData
formated as in the a .fgd file.
:return: Fgd formated string.
:rtype: str
"""
fgd_str = '@' + self._class_type
if self._name:
fgd_str += ' = "' + self.name + '"'
if self._data:
if isinstance(self._data, str):
fgd_str += ' "' + self._data + '"'
if isinstance(self._data, tuple):
fgd_str += '('
for t in self._data:
fgd_str += str(t) + ', '
fgd_str = fgd_str.strip(', ') + ')'
elif isinstance(self._data, dict):
fgd_str += '\n['
for k, v in self._data.items():
fgd_str += '\n\t"' + k + '"\n\t['
for i in v:
fgd_str += '\n\t\t"' + i + '"'
fgd_str += '\n\t]'
fgd_str += '\n]'
elif isinstance(self._data, list):
fgd_str += '\n['
for i in self._data:
fgd_str += '\n\t"' + i + '"'
fgd_str += '\n]'
return fgd_str
[docs]class FgdEntity(object):
"""An entity, as represented in a Fgd file."""
[docs] def __init__(self, class_type, definitions, name, description=None,
properties=[], spawnflags=[], inputs=[], outputs=[]):
"""Creates an instance of FgdEntity.
:param class_type: The entity's type.
Ex: 'BaseClass', 'SolidClass', 'PointClass', etc...
:type class_type: str
:param definitions: Information defining the entity within the editor.
Ex: 'base()', 'size()', 'line()', 'studioprop()', etc...
:type definitions: list[dict]
:param name: The entity's name.
:type name: str
:param description: The entity's description.
:type description: str, optional
:param properties: The entity's properties.
:type properties: list[FgdEntityProperty], optional
:param spawnflags: The entity's spawnflags.
:type spawnflags: list[FgdEntitySpawnflag], optional
:param inputs: The entity's inputs.
:type inputs: list[FgdEntityInput], optional
:param output: The entity's outputs.
:type output: list[FgdEntityOutput], optional
"""
self._class_type = class_type
self._definitions = definitions or []
self._name = name
self._description = description
self._properties = properties
self._spawnflags = spawnflags
self._inputs = inputs
self._outputs = outputs
self._parents = []
[docs] def __repr__(self):
"""A partial, printable summary of a FgdEntity.
:returns: A Python formated string.
:rtype: str
"""
return "<FgdEntity {'type': " + repr(self._class_type) + \
", 'name': " + repr(self._name) + \
(", 'description': " +
repr(shortentext(self._description, 50))
if self._description else '') + ', [...]}>'
@property
def schema(self):
"""A schematic view of this entity's attributes.
:returns: A dictionary.
:rtype: dict
"""
schema_obj = {
'name': self._name,
'description': self._description,
'class_type': self._class_type,
'definitions': self._definitions,
'properties': self.properties_schema,
'inputs': self.inputs_schema,
'outputs': self.outputs_schema,
'spawnflags': self.spawnflags_schema
}
return schema_obj
@property
def properties_schema(self):
"""A schematic view of this entity's properties.
:returns: A list of dictionaries.
:rtype: list[dict]
"""
return [p.schema for p in self.properties] + \
[{'name': 'classname',
'default_value': self._name,
'type': 'string',
'readonly': True},
{'name': 'id',
'type': 'integer',
'readonly': True}]
@property
def inputs_schema(self):
"""A schematic view of this entity's inputs.
:returns: A list of dictionaries.
:rtype: list[dict]
"""
return [i.schema for i in self.inputs]
@property
def outputs_schema(self):
"""A schematic view of this entity's outputs.
:returns: A list of dictionaries.
:rtype: list[dict]
"""
return [o.schema for o in self.outputs]
@property
def spawnflags_schema(self):
"""A schematic view of this entity's spanwnflags.
:returns: A list of dictionaries.
:rtype: list[dict]
"""
return [s.schema for s in self.spawnflags]
@property
def class_type(self):
"""The entity's type.
:rtype: str"""
return self._class_type
@property
def parents(self):
"""The entity's parent entities, as defined in the entity's \
base(definition).
:rtype: list[FgdEntity]"""
return self._parents
@property
def name(self):
"""The entity's type.
:rtype: str"""
return self._name
@property
def description(self):
"""The entity's description.
:rtype: str"""
return self._description
@property
def definitions(self):
"""The entity's definitions.
:rtype: list[dict]"""
return self._definitions
@property
def properties(self):
"""The entity's properties, including inherited properties.
Note: As in the way Hammer behaves,
properties of the same name are overridden.
:rtype: list[FgdEntityProperty]"""
properties = OrderedDict()
for parent in self._parents:
for p in parent.properties:
properties[p.name] = p
for p in self._properties:
properties[p.name] = p
return list(properties.values())
@property
def spawnflags(self):
"""The entity's spawnflags, including inherited spawnflags.
Note: As in the way Hammer behaves, the spawnflags definition
will merge with inherited definitions only if there is no
collision between values. If there is a collision, only
the latest definition will be taken into account.
:rtype: list[FgdEntitySpawnflag]"""
spawnflags = [] + self._spawnflags
ineligible_parents = []
for p in self._parents:
for s in p.spawnflags:
found = (x for x in spawnflags if x.value == s.value)
if next(found, None):
ineligible_parents.append(p)
continue
if p not in ineligible_parents:
spawnflags += p.spawnflags
return spawnflags
@property
def inputs(self):
"""The entity's inputs, including inherited inputs.
Note: As in the way Hammer behaves, inputs cannot be overridden.
All duplicate inputs are ignored, only the oldest is returned.
:rtype: list[FgdEntityInput]"""
inputs = OrderedDict()
for p in self._parents:
for i in p.inputs:
if i.name not in inputs:
inputs[i.name] = i
for i in self._inputs:
if i.name not in inputs:
inputs[i.name] = i
return list(inputs.values())
@property
def outputs(self):
"""The entity's outputs, including inherited outputs.
Note: As in the way Hammer behaves, outputs cannot be overridden.
All duplicate outputs are returned.
:rtype: list[FgdEntityOutput]"""
outputs = []
for t in self._parents:
outputs = outputs + t.outputs
outputs = outputs + self._outputs
return outputs
[docs] def property_by_name(self, prop_name):
"""Finds an entity property by its name.
:param prop_name: The entity property name to look for.
:type prop_name: str
:raises PropertyNotFound: Whenever an entity property
could not be found.
:return: An entity property with matching name.
:rtype: FgdEntityProperty
"""
result = next(
(p for p in self.properties if p.name == prop_name), None)
if not result:
raise PropertyNotFound
return result
[docs] def spawnflag_by_value(self, spawnflag_value):
"""Finds a property choice by its value.
:param spawnflag_value: The property spawnflag value to look for.
:type spawnflag_value: int
:raises SpawnflagNotFound: Whenever an entity spawnflag
could not be found.
:return: An entity spawnflag with matching value.
:rtype: FgdEntitySpawnflag
"""
result = next(
(o for o in self.spawnflags if o.value == spawnflag_value), None)
if not result:
raise SpawnflagNotFound
return result
[docs] def output_by_name(self, output_name):
"""Finds an entity output by its name.
:param output_name: The entity output name to look for.
:type output_name: str
:raises OutputNotFound: Whenever an entity output could not be found.
:return: An entity output with matching name.
:rtype: FgdEntityOutput
"""
result = next((o for o in self.outputs if o.name == output_name), None)
if not result:
raise OutputNotFound
return result
[docs] def fgd_str(self):
"""A string representation of the FgdEntity
formated as in the a .fgd file.
:return: Fgd formated string.
:rtype: str
"""
fgd_str = '@' + self._class_type
for d in self._definitions:
fgd_str += ' ' + d['name']
if 'args' in d:
fgd_str += "("
for arg in d['args']:
fgd_str += arg + ', '
fgd_str = fgd_str.strip(', ') + ')'
if self._name:
fgd_str += ' = ' + self._name
if self._description:
fgd_str += ' : "' + self._description + '"'
if self._properties or self._spawnflags or \
self._inputs or self._outputs:
fgd_str += "\n["
for prop in self._properties:
fgd_str += "\n\t" + prop.fgd_str()
if self._spawnflags:
fgd_str += "\n\tspawnflags(flags) =\n\t["
for flag in self._spawnflags:
fgd_str += "\n\t\t" + flag.fgd_str()
fgd_str += "\n\t]"
for input in self._inputs:
fgd_str += "\n\t" + input.fgd_str()
for output in self._outputs:
fgd_str += "\n\t" + output.fgd_str()
fgd_str += "\n]"
else:
fgd_str += " []"
return fgd_str
[docs]class FgdEntityProperty(object):
"""An entity property, as represented in a Fgd file."""
[docs] def __init__(self, name, value_type, readonly=False, display_name=None,
default_value=None, description=None, choices=[]):
"""Creates an instance of FgdEntityProperty.
:param name: The property's name.
:type name: str
:param value_type: The property's value type.
Ex:'integer', 'float', 'choices', etc...
:type value_type: str
:param name: The property's readonly status.
:type name: bool, optional
:param display_name: The property's display name.
:type display_name: str, optional
:param default_value: The property's unparsed default value.
:type default_value: str, optional
:param description: The property's description.
:type description: str, optional
:param choices: The property's choices.
(applicable only to value_type "choices")
:type choices: list[FgdEntityPropertyChoice], optional
"""
self._name = name
self._value_type = value_type.lower()
self._readonly = readonly
self._display_name = display_name
self._default_value = default_value
self._description = description
self._choices = choices
[docs] def __repr__(self):
"""A partial, printable summary of a FgdEntityProperty.
:returns: A Python formated string.
:rtype: str
"""
return '<FgdEntityProperty {' + \
"'name': " + repr(self._name) + \
", 'value_type': " + repr(self._value_type) + \
(", 'description': " +
repr(shortentext(self._description, 50))
if self._description else '') + ', [...]}>'
@property
def schema(self):
"""A schematic view of this entity property's attributes.
:returns: A dictionary
:rtype: dict
"""
schema_obj = {
'name': self._name,
'display_name': self._display_name,
'description': self._description,
'readonly': self._readonly,
'type': self._value_type,
'default_value': self._default_value,
}
if self.choices:
schema_obj['choices'] = [c.schema for c in self.choices]
return schema_obj
@property
def name(self):
"""The property's name.
:rtype: str"""
return self._name
@property
def value_type(self):
"""The property's type.
:rtype: str"""
return self._value_type
@property
def readonly(self):
"""The property's readonly status.
:rtype: bool"""
return self._readonly
@property
def display_name(self):
"""The property's display_name.
:rtype: str"""
return self._display_name
@property
def default_value(self):
"""The property's unparsed default_value.
:rtype: str"""
return self._default_value
@property
def description(self):
"""The property's description.
:rtype: str"""
return self._description
@property
def choices(self):
"""The property's choices.
:rtype: list[FgdEntityPropertyChoice]"""
if self._value_type == 'choices':
return self._choices
else:
return None
[docs] def choice_by_value(self, choice_value):
"""Finds a property choice by its value
:param choice_value: The property choice value to look for.
:type choice_value: int
:raises ChoiceNotFound: Whenever a property choice could not be found.
:return: A property choice with matching value.
:rtype: FgdEntityPropertyChoice
"""
if not self.choices:
raise ChoiceNotFound
result = next(
(o for o in self.choices if o.value == choice_value), None)
if not result:
raise ChoiceNotFound
return result
[docs] def fgd_str(self):
"""A string representation of the entity property
formated as in the a .fgd file.
:return: Fgd formated string.
:rtype: str
"""
# name
fgd_str = self._name + '(' + self._value_type + ')'
# readonly
if self._readonly:
fgd_str += ' readonly'
# display name
if self._display_name:
fgd_str += ' : "' + self._display_name + '"'
elif self._description or self._default_value:
fgd_str += ' :'
# default_value
if self._default_value:
fgd_str += ' : '
if isinstance(self._default_value, int):
fgd_str += str(self._default_value)
else:
fgd_str += '"' + str(self._default_value) + '"'
elif self._description:
fgd_str += ' :'
# description
if self._description:
fgd_str += ' : "' + self._description + '"'
# choices
if self.choices:
fgd_str += ' =\n\t[\n'
for choice in self.choices:
fgd_str += '\t\t' + choice.fgd_str() + '\n'
fgd_str += '\t]'
return fgd_str
[docs]class FgdEntityOutput(object):
"""An entity output, as represented in a Fgd file."""
[docs] def __init__(self, name, value_type, description=''):
"""Creates an instance of FgdEntityOutput.
:param name: The output's name.
:type name: str
:param value_type: The output's type.
:type value_type: str
:param description: The output's description.
:type description: str
"""
self._name = name
self._value_type = value_type
self._description = description
[docs] def __repr__(self):
"""A partial, printable summary of a FgdEntityOutput.
:returns: A Python formated string.
:rtype: str
"""
return '<FgdEntityOutput {' + \
"'name': " + repr(self._name) + ", " + \
"'value_type': " + repr(self._value_type) + ", " + \
"'description': " + \
repr(shortentext(self._description, 50)) + "}>"
@property
def schema(self):
"""A schematic view of this entity output's attributes.
:returns: A dictionary.
:rtype: dict
"""
schema_obj = {
'name': self._name,
'type': self._value_type,
'description': self._description,
}
return schema_obj
@property
def name(self):
"""The output's name.
:rtype: str"""
return self._name
@property
def value_type(self):
"""The output's type.
:rtype: str"""
return self._value_type
@property
def description(self):
"""The output's description.
:rtype: str"""
return self._description
[docs] def fgd_str(self):
"""A string representation of the entity output.
formated as in the a .fgd file
:return: Fgd formated string.
:rtype: str
"""
return 'output ' + self._name + '(' + self._value_type + ')' + \
' : "' + str(self.description) + '"'
[docs]class FgdEntityPropertyChoice(object):
"""A property choice, as found in entity properties of type "choices"."""
[docs] def __init__(self, value, display_name):
"""Creates an instance of FgdEntityPropertyChoice.
:param value: The choice's value.
:type value: str
:param display_name: The choice's display_name.
:type display_name: str
"""
self._value = value
self._display_name = display_name
[docs] def __repr__(self):
"""A full, printable representation of a FgdEntityPropertyChoice.
:returns: A Python formated string.
:rtype: str
"""
return '<FgdEntityPropertyChoice {' + \
"'value': " + str(self._value) + ", " + \
"'display_name': " + repr(self._display_name) + "}>"
@property
def schema(self):
"""A schematic view of this property choice.
:returns: A dictionary
:rtype: dict
"""
schema_obj = {
'value': self._value,
'display_name': self._display_name,
}
return schema_obj
@property
def value(self):
"""The choice's value.
:rtype: str"""
return self._value
@property
def display_name(self):
"""The choice's display name.
:rtype: str"""
return self._display_name
[docs] def fgd_str(self):
"""A string representation of the property choice
formated as in the a .fgd file.
:return: Fgd formated string.
:rtype: str
"""
fgd_str = ''
if isinstance(self._value, int):
fgd_str += str(self._value)
else:
fgd_str += '"' + self._value + '"'
fgd_str += ' : "' + self._display_name + '"'
return fgd_str
[docs]class FgdEntitySpawnflag(object):
"""An entity Spawnflag, as represented in a Fgd file."""
[docs] def __init__(self, value='', display_name='', default_value=None):
"""Creates an instance of FgdEntitySpawnflag.
:param value: The spawnflag's value.
:type value: int
:param display_name: The spawnflag's display_name.
:type display_name: str
:param default_value: The spawnflag's default_value.
:type default_value: bool
"""
self._value = value
self._display_name = display_name
self._default_value = default_value
[docs] def __repr__(self):
"""A full, printable representation of a FgdEntitySpawnflag.
:returns: A Python formated string.
:rtype: str
"""
return '<FgdEntitySpawnflag {' + \
"'value': " + str(self._value) + ", " + \
"'display_name': " + repr(self._display_name) + ", " + \
"'default_value': " + str(self._default_value) + "}>"
@property
def schema(self):
"""A schematic view of this Spawnflag.
:returns: A dictionary
:rtype: dict
"""
schema_obj = {
'value': self._value,
'display_name': self._display_name,
'default_value': self._default_value
}
return schema_obj
@property
def value(self):
"""The spawnflag's value.
:rtype: int"""
return self._value
@property
def display_name(self):
"""The spawnflag's display name.
:rtype: str"""
return self._display_name
@property
def default_value(self):
"""The spawnflag's default value.
:rtype: int"""
return self._default_value
[docs] def fgd_str(self):
"""A string representation of the spawnflag
formated as in the a .fgd file.
:return: Fgd formated string.
:rtype: str
"""
fgd_str = str(self._value) + ' : "'
fgd_str += self._display_name + '" : '
fgd_str += str(int(self.default_value))
return fgd_str
[docs]class EntityNotFound(Exception):
"""Raised when an entity could not be found."""
pass
[docs]class PropertyNotFound(Exception):
"""Raised when an entity property could not be found."""
pass
[docs]class OutputNotFound(Exception):
"""Raised when an entity output could not be found."""
pass
[docs]class SpawnflagNotFound(Exception):
"""Raised when an entity Spawnflag could not be found."""
pass
[docs]class ChoiceNotFound(Exception):
"""Raised when a property choice could not be found."""
pass
def shortentext(text, maxlen):
return (text[:maxlen] + '[...]') if len(text) > maxlen else text
