就业培训     下载中心     Wiki     联络 登录   注册

---

A projectdefinition.txt file that support code in a custom style can look like this:

// uses the "classic" API and the new core APIS=cinema.framework;core.framework

// turns on additional legacy support C4D = true

// to turn off stylechecks on can set the level to 0 or just set "stylecheck" to false stylecheck.level=0 // stylecheck=false

// is the level is not 0, errors can be turned into warnings //stylecheck.aswarnings=true

// custom module id ModuleId=net.maxonexample.someplugin

Further generic project settings are:

• AdditionalPreprocessorDefinitions : Preprocessor definitions.
• ExceptionHandling : Enables or disables exception handling for the project.
• RuntimeTypeInfo : Enables runtime type information for the project.
• encoding : Set to a specific encoding to hande sorce code files using that encoding e.g. encoding=utf-8 for Unicode. See this list of encodings .

样式检查

The "stylecheck" setting defines how rigid the source processor checks the source code (see 源处理器 ):

• stylecheck.level : The code check level. The minimum is 0 (check disabled), the maximum is 3 (very strict).
• stylecheck=false : Disables the style check completely.
• stylecheck.aswarnings : Turns style errors into warnings.
• stylecheck.domains : Can be used to set a list of accepted custom domains for any kind of custom ID.

Checks enabled in level 1 are:

• stylecheck.whitespace : Set to true or false to check for missing whitespaces in "if(condition)".
• stylecheck.indentation : Set to true or false to check for correct indentation.
• stylecheck.todo : Set to true or false to check for style of TODO comments.
• stylecheck.case-break : Set to true or false to check that a switch case has a break statement at its end (or MAXON_SWITCH_FALLTHROUGH).
• stylecheck.virtual : Set to true or false to check for virtual functions in frameworks.
• stylecheck.static-within-type : Set to true or false to check for declarations like const static Int x = 0; which should be written as static const Int x = 0; .
• stylecheck.supercall : Set to true or false to check if the super call is present in comparison functions of components.

Additional checks enabled in level 2 are:

• stylecheck.no-whitespace : Set to true or false to check for forbidden whitespace as in "if ( condition )".
• stylecheck.consistent-blocks : Set to true or false to check that either both or none of if / else use a {}-block, same for switch .
• stylecheck.newline-for-substatement : Set to true or false to check that the substatement of if or a loop is within a new line.
• stylecheck.explicit : Set to true or false to check that constructors which can be used as conversion constructors are marked by either explicit or MAXON_IMPLICIT.

Additional checks enabled in level 3 are:

• stylecheck.typedef-struct : Set to true or false to check for C-style struct declarations as in typedef struct { ... } S; .
• stylecheck.enum-class : Set to true or false to check that scoped enums are used ( enum class instead of just enum ).
• stylecheck.enum-registration : Set to true or false to check that enums are ended with one of the enum macros (MAXON_ENUM_LIST etc.).
• stylecheck.class-for-templateparam : Set to true or false to check that a template type parameter is introduced by typename ( template <typename T> 而不是 template <class T> ).
• stylecheck.void-paramlist : Set to true or false to check for C-style function declarations with empty parameter list as in void Func(void); .
• stylecheck.max-linecount=number : Sets the maximum line count a function may have. Default value is 500.
• stylecheck.naming : Set to true or false to check for correct naming of global variables.

注意

By default all checks are enabled. The style check level is used to disable certain checks.

The settings are processed from top to bottom. A later setting can overwrite a previous one.

Certain checks can be disabled in code using these macros:

• MAXON_WARN_MUTE_FUNCTION_LENGTH : Disables function length check.
• MAXON_WARN_MUTE_NAMING : Disables function naming scheme check.

包括

The Project Tool automatically includes source code files found in the project folder.

• Include : Includes the given file or files in the project.
• Exclude : Excludes the given file or files from the project.
• ExcludeFromBuild : Excludes the file or files from the build process, but not from the project file.
• StrictIncludeDirectories : If set to true , the locations of included files are not added to the include directories.

警告

The 源处理器 will only handle source code files stored in the "source" folder. It is advised to store all source code files in a "source" folder.

Exclude and ExcludeFromBuild do not use file paths. They define filters that are used to remove files that contain the given filter in the file path.

// the following files should be added to the Xcode project Include.OSX=../../files/someclass.h;\ ../../files/someclass.cpp;

// exclude OS specific code Exclude.Win=/source/mac/ Exclude.OSX=/source/win/

It also possible to exclude files from being checked by the Source Processor using the a specific syntax.

特定于 Visual Studio

Specific settings for Visual Studio projects. The settings can be specified for different build targets e.g. "Win64", "Debug" etc.

• AdditionalLibraryDirectories : Search paths for libraries.
• AdditionalDependencies : Library dependencies.
• AdditionalIncludeDirectories : Include directories.
• AdditionalCompileOptions : Compile options.
• AdditionalLinkOptions : Linker options
• DisableSpecificWarnings : Disables the warnings with the given numbers.
• AdditionalSolutionFiles : Adds the given files to a solution. See 解决方案 .

// the typical way to include a lib AdditionalLibraryDirectories.Win64.Debug=../../mylib/bin/ AdditionalDependencies=mylib_debug_64.lib AdditionalIncludeDirectories=../../mylib/include DisableSpecificWarnings=... DisableSpecificWarnings.Win64=...

注意

If you want to include inherit include paths you have to add "AdditionalIncludeDirectories".

特定于 Xcode

Specific settings for Xcode projects. The settings can be specified for different targets e.g. "64" and "Release".

• OTHER_LDFLAGS : Search paths for library dependencies.
• FRAMEWORK_SEARCH_PATHS : Search paths for frameworks.
• HEADER_SEARCH_PATHS : Search paths for frameworks includes like include <...>
• USER_HEADER_SEARCH_PATHS : Search paths for project includes like include "..."
• Frameworks.OSX : Adds frameworks like CoreFoundation.framework .

插件

A simple plugin's projectdefinition.txt 可以看起来像这样：

// support Windows and macOS Platform=Win64; OSX

// this is a plugin Type=DLL

// this plugin depends on these frameworks: APIS=\ cinema.framework; \ misc.framework; \ image.framework; \ core.framework

// defines the level of rigour of the source processor's style check stylecheck.level=3

// plugin/module ID ModuleId=com.examplecompany.myplugin

框架

框架的 projectdefinition.txt 可以看起来像这样：

// support Windows and macOS Platform=Win64; OSX

// this is a framework Type=Lib

// this framework depends on the listed frameworks: APIS=core.framework

// framework ID ModuleId=com.examplecompany.myplugin.framework

解决方案

A solution's projectdefinition.txt 可以看起来像这样：

// support Windows and macOS Platform=Win64; OSX

// this is a solution Type=Solution

// included plugin projects Solution=\ plugins/pluginA;\ plugins/pluginB

// include natvis files in Visual Studio solution file AdditionalSolutionFiles=\ ..\..\frameworks\core.framework\project\typeviewer\msvc\maxon.natvis;\ ..\..\frameworks\cinema.framework\project\typeviewer\msvc\c4dapi.natvis

延伸阅读

• 开发概述
• 插件开发
• SDK 概述
• 源处理器