CPAOptionable (クラス)
public abstract sealed CPAOptionable {inherits OptionListInterface}
パッケージ： CURL.IDE.CPA.ENVIRONMENT
直接継承しているサブクラス: CPAProjectPreferences, CPAPackage, CPALibrary, CPASessionBase

Class that handles CPA compilation options.

説明

This base class declares the nonlocal options for controlling optional CPA analysis.

Options are looked up in the following objects in order:

  1. the package
  2. the package's library
  3. the library's preferences
  4. the session


Options set directly in the package or library originate from package/manifest meta-data declarations, where the option name is prefixed with cpa-, e.g.:

{package MY-TEST-PACKAGE,
    || Test packages don't need to be localized.
    cpa-detect-unlocalized-strings? = false
}


Options set in the session or library preferences object must be set explicitly based on UI preference changes.

プロパティ
analyze-doc-strings?:Should doc strings be analyzed?
非ローカル オプション public CPAOptionable.analyze-doc-strings?:bool
detect-ignored-exceptions?:Detect caught and ignored exceptions
非ローカル オプション public CPAOptionable.detect-ignored-exceptions?:bool
detect-missing-components?:Detect missing component files in manifest.
非ローカル オプション public CPAOptionable.detect-missing-components?:bool
detect-missing-doc-strings?:Detect missing doc strings for public/protected members?
非ローカル オプション public CPAOptionable.detect-missing-doc-strings?:bool
detect-null-dereferences?:Detect potential null dereferences
非ローカル オプション public CPAOptionable.detect-null-dereferences?:bool
detect-parameter-dependencies?:Detect implicit assumptions in parameterized classes.
非ローカル オプション public CPAOptionable.detect-parameter-dependencies?:bool
detect-unlocalized-strings?:Detect unlocalized strings?
非ローカル オプション public CPAOptionable.detect-unlocalized-strings?:bool
detect-unused-arguments?:Detect unused function arguments?
非ローカル オプション public CPAOptionable.detect-unused-arguments?:bool
detect-unused-values?:Detect unused values.
非ローカル オプション public CPAOptionable.detect-unused-values?:bool
detect-unused-variables?:Detect unused local variables?
非ローカル オプション public CPAOptionable.detect-unused-variables?:bool
detect-useless-casts?:Detect useless explicit casts?
非ローカル オプション public CPAOptionable.detect-useless-casts?:bool
disallow-doc-text?:Detect top-level text in doc-strings?
非ローカル オプション public CPAOptionable.disallow-doc-text?:bool
doc-path-regexp:Identifies documentation files.
非ローカル オプション public CPAOptionable.doc-path-regexp:String
file-close-characters:File character threshold for file close policy
非ローカル オプション public CPAOptionable.file-close-characters:int
file-close-policy:Determine when files should be closed to save memory.
非ローカル オプション public CPAOptionable.file-close-policy:int
max-doc-purpose-length:Maximum number of characters in purpose clause in doc string.
非ローカル オプション public CPAOptionable.max-doc-purpose-length:int
max-function-nodes:Maximum size of functions before producing warning.
非ローカル オプション public CPAOptionable.max-function-nodes:int
metrics-internal-scope:Scope to be used for computing dependency metrics.
非ローカル オプション public CPAOptionable.metrics-internal-scope:String
options:このオブジェクトのオプション リストが存在する場合はそれを参照します。
アクセサ protected CPAOptionable.options:#OptionItem
セッター protected CPAOptionable.options:#OptionItem
require-doc-purpose?:Detect missing purpose clause in doc strings
非ローカル オプション public CPAOptionable.require-doc-purpose?:bool
require-doc-signature?:Require signature clause in macro doc strings
非ローカル オプション public CPAOptionable.require-doc-signature?:bool
restrict-doc-clauses?:Restrict docstring clauses
非ローカル オプション public CPAOptionable.restrict-doc-clauses?:bool
target-arch:Override behavior of platform-switch.
非ローカル オプション public CPAOptionable.target-arch:String
target-os:Override behavior of platform-switch.
非ローカル オプション public CPAOptionable.target-os:String
test-path-regexp:Identifies test files.
非ローカル オプション public CPAOptionable.test-path-regexp:String
validate-docrefs?:Do docref validation
非ローカル オプション public CPAOptionable.validate-docrefs?:bool
プロパティ 継承 OptionListInterface: option-parent, option-register-proc, options-present-here, registered-option-keys, style-options

クラス プロシージャ
get-options:Lists currently supported CPA options.
public {CPAOptionable.get-options}:{Iterator-of Option}

メソッド
update-cpa-options-from-meta-data:
protected final {CPAOptionable.update-cpa-options-from-meta-data
old-md:#ComponentMetaData,
new-md:#ComponentMetaData
}:void
update-option-by-name-from-string:Updates named option from a string.
public final {CPAOptionable.update-option-by-name-from-string
name:String,
value-str:#String
}:void
メソッド 継承 OptionListInterface: add-option, add-style-option, change-option-parent-notify, clone-options, get-option, get-option-by-name, keyword-init-arg, local-add-notify, local-remove-notify, name-to-option-key, new-option-item, notify-option-children, option-change-notify, option-changed, option-lookup, option-lookup-here, option-propagate-notify, option-set?, propagate-option-change, register-options, remove-option, remove-style-option, remove-styles, set-option-by-name, set-style-option-by-name, unset-option-by-name, unset-style-option-by-name
メソッド 継承 InitRestArgParser: non-keyword-init-arg, process-rest-args
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize




プロパティ詳細
analyze-doc-strings? (非ローカル オプション)
public CPAOptionable.analyze-doc-strings?:bool

Should doc strings be analyzed?

説明

See analyze-doc-strings?

detect-ignored-exceptions? (非ローカル オプション)
public CPAOptionable.detect-ignored-exceptions?:bool

Detect caught and ignored exceptions

説明

See detect-ignored-exceptions?

detect-missing-components? (非ローカル オプション)
public CPAOptionable.detect-missing-components?:bool

Detect missing component files in manifest.

説明

See detect-missing-components?

detect-missing-doc-strings? (非ローカル オプション)
public CPAOptionable.detect-missing-doc-strings?:bool

Detect missing doc strings for public/protected members?

説明

See detect-missing-doc-strings?

detect-null-dereferences? (非ローカル オプション)
public CPAOptionable.detect-null-dereferences?:bool

Detect potential null dereferences

説明

See detect-null-dereferences?

detect-parameter-dependencies? (非ローカル オプション)
public CPAOptionable.detect-parameter-dependencies?:bool

Detect implicit assumptions in parameterized classes.

説明

See detect-parameter-dependencies?

detect-unlocalized-strings? (非ローカル オプション)
public CPAOptionable.detect-unlocalized-strings?:bool

Detect unlocalized strings?

説明

See detect-unlocalized-strings?

detect-unused-arguments? (非ローカル オプション)
public CPAOptionable.detect-unused-arguments?:bool

Detect unused function arguments?

説明

See detect-unused-arguments?

detect-unused-values? (非ローカル オプション)
public CPAOptionable.detect-unused-values?:bool

Detect unused values.

説明

See detect-unused-values?

detect-unused-variables? (非ローカル オプション)
public CPAOptionable.detect-unused-variables?:bool

Detect unused local variables?

説明

See detect-unused-variables?

detect-useless-casts? (非ローカル オプション)
public CPAOptionable.detect-useless-casts?:bool

Detect useless explicit casts?

説明

See detect-useless-casts?

disallow-doc-text? (非ローカル オプション)
public CPAOptionable.disallow-doc-text?:bool

Detect top-level text in doc-strings?

説明

See disallow-doc-text?

doc-path-regexp (非ローカル オプション)
public CPAOptionable.doc-path-regexp:String

Identifies documentation files.

説明

See doc-path-regexp

file-close-characters (非ローカル オプション)
public CPAOptionable.file-close-characters:int

File character threshold for file close policy

説明

See file-close-characters

file-close-policy (非ローカル オプション)
public CPAOptionable.file-close-policy:int

Determine when files should be closed to save memory.

説明

See file-close-policy

max-doc-purpose-length (非ローカル オプション)
public CPAOptionable.max-doc-purpose-length:int

Maximum number of characters in purpose clause in doc string.

説明

See max-doc-purpose-length

max-function-nodes (非ローカル オプション)
public CPAOptionable.max-function-nodes:int

Maximum size of functions before producing warning.

説明

See max-function-nodes.

metrics-internal-scope (非ローカル オプション)
public CPAOptionable.metrics-internal-scope:String

Scope to be used for computing dependency metrics.

説明

See metrics-internal-scope

options (アクセサ)
アクセサ protected CPAOptionable.options:#OptionItem
セッター protected CPAOptionable.options:#OptionItem

このオブジェクトのオプション リストが存在する場合はそれを参照します。

説明

オプション リストは OptionItem へリンクしたリストとして表現されます。
(スタイル シートを通しているか直接設定されているかにかかわらず) Visual に設定されたオプションの全てを リストしたい場合は Visual.options-present-here ゲッターを使用してください。

require-doc-purpose? (非ローカル オプション)
public CPAOptionable.require-doc-purpose?:bool

Detect missing purpose clause in doc strings

説明

See require-doc-purpose?

require-doc-signature? (非ローカル オプション)
public CPAOptionable.require-doc-signature?:bool

Require signature clause in macro doc strings

説明

See require-doc-signature?

restrict-doc-clauses? (非ローカル オプション)
public CPAOptionable.restrict-doc-clauses?:bool

Restrict docstring clauses

説明

See restrict-doc-clauses?

target-arch (非ローカル オプション)
public CPAOptionable.target-arch:String

Override behavior of platform-switch.

説明

See target-arch

target-os (非ローカル オプション)
public CPAOptionable.target-os:String

Override behavior of platform-switch.

説明

See target-os

test-path-regexp (非ローカル オプション)
public CPAOptionable.test-path-regexp:String

Identifies test files.

説明

See test-path-regexp

validate-docrefs? (非ローカル オプション)
public CPAOptionable.validate-docrefs?:bool

Do docref validation

説明

See validate-docrefs?



クラス プロシージャ詳細
get-options (クラスプロシージャ)
public {CPAOptionable.get-options}:{Iterator-of Option}

Lists currently supported CPA options.



メソッド詳細
update-cpa-options-from-meta-data (メソッド)
protected final {CPAOptionable.update-cpa-options-from-meta-data
old-md:#ComponentMetaData,
new-md:#ComponentMetaData
}:void
""

update-option-by-name-from-string (メソッド)
public final {CPAOptionable.update-option-by-name-from-string
name:String,
value-str:#String
}:void

Updates named option from a string.

説明

This sets or unsets the option with given name from value-str:



This will throw an exception if there is no option name or if the value type is not compatible with the option.