Skip to content

Commit 6dad84b

Browse files
committed
Update ClangSharpPInvokeGenerator usage
1 parent 604d448 commit 6dad84b

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -155,32 +155,33 @@ Options:
155155
-e, --exclude <exclude> A declaration name to exclude from binding generation. []
156156
-f, --file <file> A file to parse and generate bindings for. []
157157
-F, --file-directory <file-directory> The base path for files to parse. []
158-
-h, --headerFile <headerFile> A file which contains the header to prefix every generated file with. []
158+
-hf, --headerFile <headerFile> A file which contains the header to prefix every generated file with. []
159159
-i, --include <include> A declaration name to include in binding generation. []
160160
-I, --include-directory <include-directory> Add directory to include search path. []
161-
-x, --language <language> Treat subsequent input files as having type <language>. [default: c++]
161+
-x, --language <c|c++> Treat subsequent input files as having type <language>. [default: c++]
162162
-l, --libraryPath <libraryPath> The string to use in the DllImport attribute used when generating bindings. []
163163
-m, --methodClassName <methodClassName> The name of the static class that will contain the generated method bindings. [default: Methods]
164164
-n, --namespace <namespace> The namespace in which to place the generated bindings. []
165-
--nativeTypeNamesToStrip The contents to strip from the generated NativeTypeName attributes.
166165
-om, --output-mode <CSharp|Xml> The mode describing how the information collected from the headers are presented in the resultant bindings. [default: CSharp]
167-
-o, --output <output> The output location to write the generated bindings to. []
166+
-o, --output <output> The output location to write the generated bindings to. []
168167
-p, --prefixStrip <prefixStrip> The prefix to strip from the generated method bindings. []
168+
--nativeTypeNamesToStrip <nativeTypeNamesToStrip> The contents to strip from the generated NativeTypeName attributes. []
169169
-r, --remap <remap> A declaration name to be remapped to another name during binding generation. []
170-
-std, --std <std> Language standard to compile for. []
170+
-std <std> Language standard to compile for. []
171171
-to, --test-output <test-output> The output location to write the generated tests to. []
172172
-t, --traverse <traverse> A file name included either directly or indirectly by -f that should be traversed during binding generation. []
173-
-v, --version <version> Prints the current version information for the tool and its native dependencies.
173+
-v, --version Prints the current version information for the tool and its native dependencies.
174174
-was, --with-access-specifier <with-access-specifier> An access specifier to be used with the given qualified or remapped declaration name during binding generation. Supports wildcards. []
175175
-wa, --with-attribute <with-attribute> An attribute to be added to the given remapped declaration name during binding generation. Supports wildcards. []
176176
-wcc, --with-callconv <with-callconv> A calling convention to be used for the given declaration during binding generation. Supports wildcards. []
177177
-wc, --with-class <with-class> A class to be used for the given remapped constant or function declaration name during binding generation. Supports wildcards. []
178178
-wg, --with-guid <with-guid> A GUID to be used for the given declaration during binding generation. Supports wildcards. []
179+
-wl, --with-length <with-length> A length to be used for the given declaration during binding generation. Supports wildcards. []
179180
-wlb, --with-librarypath <with-librarypath> A library path to be used for the given declaration during binding generation. Supports wildcards. []
180181
-wmi, --with-manual-import <with-manual-import> A remapped function name to be treated as a manual import during binding generation. Supports wildcards. []
181182
-wn, --with-namespace <with-namespace> A namespace to be used for the given remapped declaration name during binding generation. Supports wildcards. []
182183
-wp, --with-packing <with-packing> Overrides the StructLayoutAttribute.Pack property for the given type. Supports wildcards. []
183-
-wsle, --with-setlasterror <with-setlasterror> Add the SetLastError=true modifier to a given DllImport or UnmanagedFunctionPointer. Supports wildcards. []
184+
-wsle, --with-setlasterror <with-setlasterror> Add the SetLastError=true modifier or SetsSystemLastError attribute to a given DllImport or UnmanagedFunctionPointer. Supports wildcards. []
184185
-wsgct, --with-suppressgctransition <with-suppressgctransition> Add the SuppressGCTransition calling convention to a given DllImport or UnmanagedFunctionPointer. Supports wildcards. []
185186
-wts, --with-transparent-struct <with-transparent-struct> A remapped type name to be treated as a transparent wrapper during binding generation. Supports wildcards. []
186187
-wt, --with-type <with-type> A type to be used for the given enum declaration during binding generation. Supports wildcards. []
@@ -218,7 +219,7 @@ Options:
218219
# Exclusion Options
219220
220221
exclude-anonymous-field-helpers The helper ref properties generated for fields in nested anonymous structs and unions should not be generated.
221-
exclude-com-proxies Types recognized as COM proxies should not have bindings generated. Thes are currently function declarations ending with _UserFree, _UserMarshal, _UserSize, _UserUnmarshal, _Proxy, or _Stub.
222+
exclude-com-proxies Types recognized as COM proxies should not have bindings generated. These are currently function declarations ending with _UserFree, _UserMarshal, _UserSize, _UserUnmarshal, _Proxy, or _Stub.
222223
exclude-default-remappings Default remappings for well known types should not be added. This currently includes intptr_t, ptrdiff_t, size_t, and uintptr_t
223224
exclude-empty-records Bindings for records that contain no members should not be generated. These are commonly encountered for opaque handle like types such as HWND.
224225
exclude-enum-operators Bindings for operators over enum types should not be generated. These are largely unnecessary in C# as the operators are available by default.
@@ -243,14 +244,15 @@ Options:
243244
generate-callconv-member-function Instance function pointers should use [CallConvMemberFunction] where applicable.
244245
generate-cpp-attributes [CppAttributeList("")] should be generated to document the encountered C++ attributes.
245246
generate-disable-runtime-marshalling [assembly: DisableRuntimeMarshalling] should be generated.
246-
generate-doc-includes &lt;include&gt; xml documentation tags should be generated for declarations.
247+
generate-doc-includes <include> xml documentation tags should be generated for declarations.
247248
generate-file-scoped-namespaces Namespaces should be scoped to the file to reduce nesting.
248249
generate-guid-member Types with an associated GUID should have a corresponding member generated.
249250
generate-helper-types Code files should be generated for various helper attributes and declared transparent structs.
250251
generate-macro-bindings Bindings for macro-definitions should be generated. This currently only works with value like macros and not function-like ones.
251252
generate-marker-interfaces Bindings for marker interfaces representing native inheritance hierarchies should be generated.
252-
generate-native-bitfield-attribute [NativeBitfield(\"\", offset: #, length: #)] attribute should be generated to document the encountered bitfield layout.
253+
generate-native-bitfield-attribute [NativeBitfield("", offset: #, length: #)] attribute should be generated to document the encountered bitfield layout.
253254
generate-native-inheritance-attribute [NativeInheritance("")] attribute should be generated to document the encountered C++ base type.
255+
generate-generic-pointer-wrapper Pointer<T> should be used for limited generic type support.
254256
generate-setslastsystemerror-attribute [SetsLastSystemError] attribute should be generated rather than using SetLastError = true.
255257
generate-template-bindings Bindings for template-definitions should be generated. This is currently experimental.
256258
generate-unmanaged-constants Unmanaged constants should be generated using static ref readonly properties. This is currently experimental.

0 commit comments

Comments
 (0)