bartvdbraak/blender
1
0
Fork 4
Code Issues 4 Pull Requests 1 Actions 1 Packages Projects Releases Wiki Activity
main
blender/source/creator/creator_intern.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

126 lines
3.1 KiB
C
Raw Permalink Normal View History

License Headers: Set copyright to "Blender Authors", add AUTHORS Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
2023-08-15 14:20:26 +00:00
/* SPDX-FileCopyrightText: 2023 Blender Authors
Cleanup: Add a copyright notice to files and use SPDX format A lot of files were missing copyright field in the header and the Blender Foundation contributed to them in a sense of bug fixing and general maintenance. This change makes it explicit that those files are at least partially copyrighted by the Blender Foundation. Note that this does not make it so the Blender Foundation is the only holder of the copyright in those files, and developers who do not have a signed contract with the foundation still hold the copyright as well. Another aspect of this change is using SPDX format for the header. We already used it for the license specification, and now we state it for the copyright as well, following the FAQ: https://reuse.software/faq/
2023-05-31 14:19:06 +00:00
*
* SPDX-License-Identifier: GPL-2.0-or-later */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
#pragma once
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-17 21:08:12 +00:00
/** \file
* \ingroup creator
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
*
* Functionality for main() initialization.
*/
Refactor: generalize deferred command line argument execution Making arguments call into Python was impractical because Python is only initialized for ARG_PASS_FINAL. Replace "--command" specific logic with a general method of arguments requesting to be executed once all sub-systems have been initialized. Without this, the `main()` function needs hard coded logic to support any time an argument needs to use Python internally.
2024-04-05 00:24:07 +00:00
struct BA_ArgCallback_Deferred;
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
struct bArgs;
struct bContext;
BLO: move blenloader to C++ Differential Revision: https://developer.blender.org/D15965
2022-09-15 17:13:01 +00:00
#ifdef __cplusplus
extern "C" {
#endif
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
#ifndef WITH_PYTHON_MODULE
Cleanup: use full sentences for code-comments Also correct references source files.
2024-03-19 02:57:00 +00:00
/* `creator_args.cc` */
Cleanup: ensure space after file named in headers Add blank lines after file references to avoid them being interpreted as doc-strings the following declarations.
2022-04-04 03:17:03 +00:00
Refactor: split file loading into its own function Function naming made it seem main_args_setup might need to call main_args_setup_post, when this was in fact only needed for handing final arguments. Call BLI_args_parse directly and expose main_args_handle_load_file as a public function. Move handle_load_file into a separate function which is called by --open-last.
2023-05-29 02:44:38 +00:00
/**
* \param all: When enabled, all arguments are initialized
* even for configurations that don't apply to the current system.
* Used for documentation (see Python API: `bpy.app.help_text(all=True)`).
*/
ByAPI: add "all" argument to bpy.app.help_text, to show all help text Optionally extract all help text, even for options not available on the current platform or with the current build options. Useful so it's possible to extract help text for the user-manual which doesn't depend on the blender build used for extraction.
2023-05-27 07:23:19 +00:00
void main_args_setup(struct bContext *C, struct bArgs *ba, bool all);
Refactor: split file loading into its own function Function naming made it seem main_args_setup might need to call main_args_setup_post, when this was in fact only needed for handing final arguments. Call BLI_args_parse directly and expose main_args_handle_load_file as a public function. Move handle_load_file into a separate function which is called by --open-last.
2023-05-29 02:44:38 +00:00
/**
* Handler for loading blend files.
* \note arguments that cannot be parsed are assumed to be blend files.
*/
int main_args_handle_load_file(int argc, const char **argv, void *data);
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
Refactor: generalize deferred command line argument execution Making arguments call into Python was impractical because Python is only initialized for ARG_PASS_FINAL. Replace "--command" specific logic with a general method of arguments requesting to be executed once all sub-systems have been initialized. Without this, the `main()` function needs hard coded logic to support any time an argument needs to use Python internally.
2024-04-05 00:24:07 +00:00
/**
* Handle an argument which requested deferred evaluation.
* Needed when arguments which evaluate early need Python to be initialized for example.
*/
Fix crash using "--command" on Windows Use after free error accessing command line arguments on windows. Resolve by duplicating the arguments when a "--command" is passed in.
2024-04-10 01:49:08 +00:00
int main_arg_deferred_handle();
void main_arg_deferred_free();
Refactor: generalize deferred command line argument execution Making arguments call into Python was impractical because Python is only initialized for ARG_PASS_FINAL. Replace "--command" specific logic with a general method of arguments requesting to be executed once all sub-systems have been initialized. Without this, the `main()` function needs hard coded logic to support any time an argument needs to use Python internally.
2024-04-05 00:24:07 +00:00
Cleanup: use full sentences for code-comments Also correct references source files.
2024-03-19 02:57:00 +00:00
/* `creator_signals.cc` */
Cleanup: ensure space after file named in headers Add blank lines after file references to avoid them being interpreted as doc-strings the following declarations.
2022-04-04 03:17:03 +00:00
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
void main_signal_setup(void);
void main_signal_setup_background(void);
void main_signal_setup_fpe(void);
Cleanup: clarify #ifndef checks in trailing #endif comments
2023-12-06 23:35:23 +00:00
#endif /* !WITH_PYTHON_MODULE */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
Cleanup: update comments Some references to argument levels were still in comments.
2020-10-28 05:00:26 +00:00
/** Shared data for argument handlers to store state in. */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
struct ApplicationState {
struct {
bool use_crash_handler;
bool use_abort_handler;
} signal;
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 04:17:24 +00:00
Cleanup: use full sentences for code-comments Also correct references source files.
2024-03-19 02:57:00 +00:00
/* We may want to set different exit codes for other kinds of errors. */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
struct {
unsigned char python;
} exit_code_on_error;
CLI: support defining custom commands via C++ & Python API Add support for add-ons to define commands using the new argument `-c` or `--command`. Commands behave as follows: - Passing in a command enables background mode without the need to pass in `--background`. - All arguments following the command are passed to the command (without the need to use the `--` argument). - Add-ons can define their own commands via `bpy.utils.register_cli_command` (see examples in API docs). - Passing in `--command help` lists all available commands. Ref !119115
2024-03-08 00:07:41 +00:00
Refactor: generalize deferred command line argument execution Making arguments call into Python was impractical because Python is only initialized for ARG_PASS_FINAL. Replace "--command" specific logic with a general method of arguments requesting to be executed once all sub-systems have been initialized. Without this, the `main()` function needs hard coded logic to support any time an argument needs to use Python internally.
2024-04-05 00:24:07 +00:00
/** Store the argument state for later handling. */
struct BA_ArgCallback_Deferred *main_arg_deferred;
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
};
Refactor: generalize deferred command line argument execution Making arguments call into Python was impractical because Python is only initialized for ARG_PASS_FINAL. Replace "--command" specific logic with a general method of arguments requesting to be executed once all sub-systems have been initialized. Without this, the `main()` function needs hard coded logic to support any time an argument needs to use Python internally.
2024-04-05 00:24:07 +00:00
Cleanup: use full sentences for code-comments Also correct references source files.
2024-03-19 02:57:00 +00:00
extern struct ApplicationState app_state; /* `creator.cc` */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
Cleanup: use enum for command line argument passes
2020-10-28 01:58:27 +00:00
/**
* Passes for use by #main_args_setup.
* Keep in order of execution.
*/
enum {
Cleanup: update comments Some references to argument levels were still in comments.
2020-10-28 05:00:26 +00:00
/** Run before sub-system initialization. */
BLI_args: disallow zero to be used as a pass value Introduced recently in 09139e41ed4ea. While this worked in the cases it was used, '--threads' for example was failing to parse the number when it's pass was set to 0. Increase the enum values to start at 1 & add asserts so this wont happen again.
2020-10-28 02:07:31 +00:00
ARG_PASS_ENVIRONMENT = 1,
Cleanup: update comments Some references to argument levels were still in comments.
2020-10-28 05:00:26 +00:00
/** General settings parsing, also animation player. */
BLI_args: disallow zero to be used as a pass value Introduced recently in 09139e41ed4ea. While this worked in the cases it was used, '--threads' for example was failing to parse the number when it's pass was set to 0. Increase the enum values to start at 1 & add asserts so this wont happen again.
2020-10-28 02:07:31 +00:00
ARG_PASS_SETTINGS = 2,
Cleanup: update comments Some references to argument levels were still in comments.
2020-10-28 05:00:26 +00:00
/** Windowing & graphical settings (ignored in background mode). */
BLI_args: disallow zero to be used as a pass value Introduced recently in 09139e41ed4ea. While this worked in the cases it was used, '--threads' for example was failing to parse the number when it's pass was set to 0. Increase the enum values to start at 1 & add asserts so this wont happen again.
2020-10-28 02:07:31 +00:00
ARG_PASS_SETTINGS_GUI = 3,
Cleanup: update comments Some references to argument levels were still in comments.
2020-10-28 05:00:26 +00:00
/** Currently use for audio devices. */
BLI_args: disallow zero to be used as a pass value Introduced recently in 09139e41ed4ea. While this worked in the cases it was used, '--threads' for example was failing to parse the number when it's pass was set to 0. Increase the enum values to start at 1 & add asserts so this wont happen again.
2020-10-28 02:07:31 +00:00
ARG_PASS_SETTINGS_FORCE = 4,
Cleanup: use enum for command line argument passes
2020-10-28 01:58:27 +00:00
Fix failure to cleanup temporary files with '--python-exit-code' Note that handlers for the `ARG_PASS_FINAL` pass must always use WM_exit instead of calling exit directly.
2023-05-31 00:17:41 +00:00
/**
* Actions & fall back to loading blend file.
*
* \note arguments in the final pass must use #WM_exit instead of `exit()` environment is
* properly shut-down (temporary directory deleted, etc).
*/
BLI_args: disallow zero to be used as a pass value Introduced recently in 09139e41ed4ea. While this worked in the cases it was used, '--threads' for example was failing to parse the number when it's pass was set to 0. Increase the enum values to start at 1 & add asserts so this wont happen again.
2020-10-28 02:07:31 +00:00
ARG_PASS_FINAL = 5,
Cleanup: use enum for command line argument passes
2020-10-28 01:58:27 +00:00
};
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
/* for the callbacks: */
#ifndef WITH_PYTHON_MODULE
Fix various Blender 3.0 versioning issues This changes the following items: - package name is now `blender-3.0.0-git.09eb04c0a865-windows64` rather than `blender-3.00.0-git.09eb04c0a865-windows64` - Fix version resource for blender.exe not building - Data directories are now `3.0\...` rather than `3.00\....` - User prefs are now in: `c:\Users\users\AppData\Roaming\Blender Foundation\Blender\3.0\` rather than: `c:\Users\users\AppData\Roaming\Blender Foundation\Blender\3.00\` - Updating startup & preferences from previous release has a special exception for 3.0 to check for 3.93 and older. See T87532 Ref D10986
2021-04-16 01:17:23 +00:00
# define BLEND_VERSION_FMT "Blender %d.%d.%d"
Cleanup: macro hygiene, use parenthesis around operators
2021-02-13 06:03:20 +00:00
# define BLEND_VERSION_ARG (BLENDER_VERSION / 100), (BLENDER_VERSION % 100), BLENDER_VERSION_PATCH
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
#endif
#ifdef WITH_BUILDINFO_HEADER
# define BUILD_DATE
#endif
Cleanup: spelling
2022-09-19 04:47:27 +00:00
/* From `buildinfo.c`. */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
#ifdef BUILD_DATE
extern char build_date[];
extern char build_time[];
extern char build_hash[];
extern unsigned long build_commit_timestamp;
Cleanup: spelling
2022-09-19 04:47:27 +00:00
/* TODO(@sergey): ideally size need to be in sync with `buildinfo.c`. */
Cleanup split creator.c creator.c was getting hard to follow. - Split off argument and signal handling into own files. - Move docstrings next to functions (to keep docs grouped with code).
2016-02-27 18:10:00 +00:00
extern char build_commit_date[16];
extern char build_commit_time[16];
extern char build_branch[];
extern char build_platform[];
extern char build_type[];
extern char build_cflags[];
extern char build_cxxflags[];
extern char build_linkflags[];
extern char build_system[];
Cleanup: update comments Some references to argument levels were still in comments.
2020-10-28 05:00:26 +00:00
#endif /* BUILD_DATE */
BLO: move blenloader to C++ Differential Revision: https://developer.blender.org/D15965
2022-09-15 17:13:01 +00:00
#ifdef __cplusplus
}
#endif
Reference in New Issue Copy Permalink