godot/modules/vorbis/config.py

def can_build(env, platform):
    env.module_add_dependencies("vorbis", ["ogg"])
    return True


def configure(env):
    pass


def get_doc_classes():
    return [
        "AudioStreamOggVorbis",
        "AudioStreamPlaybackOggVorbis",
        "ResourceImporterOggVorbis",
    ]


def get_doc_path():
    return "doc_classes"
SCons: Pass env to modules can_build method This allows to disable modules based on the environment, in particular `env[tools]` which tells us if we are building the editor or not. 2018-05-30 17:11:33 +00:00			`def can_build(env, platform):`
[Scons] Implement module dependency sorting. Modules can now call: env.module_add_dependencies(name: str, deps: list, optional: bool) To add required or optional dependencies during the "can_build" step. Required dependencies will be checked and the module will be not be enabled when they are missing, printing a warning to notify the user. 2022-08-04 17:11:01 +00:00			`env.module_add_dependencies("vorbis", ["ogg"])`
			`return True`
ogg/vorbis/opus: Make them modules and unbundle thirdparty libs Took the opportunity to undo the Godot changed made to the opus source. The opus module should eventually be built in its own environment to avoid polluting others with too many include dirs and defines. TODO: Fix the platform/ stuff for opus. 2016-10-12 18:37:38 +00:00
SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted. 2020-03-30 06:28:32 +00:00
ogg/vorbis/opus: Make them modules and unbundle thirdparty libs Took the opportunity to undo the Godot changed made to the opus source. The opus module should eventually be built in its own environment to avoid polluting others with too many include dirs and defines. TODO: Fix the platform/ stuff for opus. 2016-10-12 18:37:38 +00:00			`def configure(env):`
style: Start applying PEP8 to Python files, indentation issues Done with `autopep8 --select=E1`, fixes: - E101 - Reindent all lines. - E112 - Fix under-indented comments. - E113 - Fix over-indented comments. - E115 - Fix under-indented comments. - E116 - Fix over-indented comments. - E121 - Fix a badly indented line. - E122 - Fix a badly indented line. - E123 - Fix a badly indented line. - E124 - Fix a badly indented line. - E125 - Fix indentation undistinguish from the next logical line. - E126 - Fix a badly indented line. - E127 - Fix a badly indented line. - E128 - Fix a badly indented line. - E129 - Fix a badly indented line. 2016-10-30 17:44:57 +00:00			`pass`
Replace stb_vorbis with libogg+libvorbis 2021-09-10 01:54:18 +00:00

			`def get_doc_classes():`
			`return [`
Rename every instance of "OGG" to "Ogg" 2022-07-28 18:34:41 +00:00			`"AudioStreamOggVorbis",`
			`"AudioStreamPlaybackOggVorbis",`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 20:34:34 +00:00			`"ResourceImporterOggVorbis",`
Replace stb_vorbis with libogg+libvorbis 2021-09-10 01:54:18 +00:00			`]`


			`def get_doc_path():`
			`return "doc_classes"`