This repository was archived by the owner on Mar 9, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 91
Expand file tree
/
Copy pathIronPython.Modules.xml
More file actions
2565 lines (2482 loc) · 121 KB
/
IronPython.Modules.xml
File metadata and controls
2565 lines (2482 loc) · 121 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>IronPython.Modules</name>
</assembly>
<members>
<member name="M:IronPython.Modules.Bz2.Bz2Module.BZ2Compressor.GetLatestData">
<summary>
Copy the latest data from the memory buffer.
This won't always contain data, because comrpessed data is only written after a block is filled.
</summary>
<returns></returns>
</member>
<member name="M:IronPython.Modules.Bz2.Bz2Module.BZ2Decompressor.AddData(System.Byte[])">
<summary>
Add data to the input buffer. This manipulates the position of the stream
to make it appear to the BZip2 stream that nothing has actually changed.
</summary>
<param name="bytes">The data to append to the buffer.</param>
</member>
<member name="M:IronPython.Modules.Bz2.Bz2Module.ToArrayNoCopy(System.Collections.Generic.IList{System.Byte})">
<summary>
Try to convert IList(Of byte) to byte[] without copying, if possible.
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="M:IronPython.Modules.PythonCopyReg.EnsureCallable(IronPython.Runtime.CodeContext,System.Object,System.String)">
<summary>
Throw TypeError with a specified message if object isn't callable.
</summary>
</member>
<member name="M:IronPython.Modules.PythonCopyReg.GetCode(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Convert object to ushort, throwing ValueError on overflow.
</summary>
</member>
<member name="T:IronPython.Modules.PythonPickle.FileInput">
<summary>
Interface for "file-like objects" that implement the protocol needed by load() and friends.
This enables the creation of thin wrappers that make fast .NET types and slow Python types look the same.
</summary>
</member>
<member name="T:IronPython.Modules.PythonPickle.FileOutput">
<summary>
Interface for "file-like objects" that implement the protocol needed by dump() and friends.
This enables the creation of thin wrappers that make fast .NET types and slow Python types look the same.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.SaveObject(IronPython.Modules.PythonPickle.PicklerObject,IronPython.Runtime.CodeContext,System.Object)">
<summary>
Call the appropriate reduce method for obj and pickle the object using
the resulting data. Use the first available of
copy_reg.dispatch_table[type(obj)], obj.__reduce_ex__, and obj.__reduce__.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.SaveReduce(IronPython.Runtime.CodeContext,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
<summary>
Pickle the result of a reduce function.
Only context, obj, func, and reduceCallable are required; all other arguments may be null.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteFloatAsString(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle decimalnl_short format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteFloat64(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle float8 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUInt8(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle uint1 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUInt16(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle uint2 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteInt32(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle int4 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteIntAsString(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle decimalnl_short format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteIntAsString(IronPython.Runtime.CodeContext,System.Int32)">
<summary>
Write value in pickle decimalnl_short format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteLongAsString(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle decimalnl_long format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUnicodeStringRaw(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle unicodestringnl format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteUnicodeStringUtf8(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Write value in pickle unicodestring4 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.WriteStringPair(IronPython.Runtime.CodeContext,System.Object,System.Object)">
<summary>
Write value in pickle stringnl_noescape_pair format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.IsUInt8(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Return true if value is appropriate for formatting in pickle uint1 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.IsUInt16(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Return true if value is appropriate for formatting in pickle uint2 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.IsInt32(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Return true if value is appropriate for formatting in pickle int4 format.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.BatchAppends(IronPython.Runtime.CodeContext,System.Collections.IEnumerator)">
<summary>
Emit a series of opcodes that will set append all items indexed by iter
to the object at the top of the stack. Use APPENDS if possible, but
append no more than BatchSize items at a time.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.BatchSetItems(IronPython.Runtime.CodeContext,IronPython.Runtime.PythonDictionary)">
<summary>
Emit a series of opcodes that will set all (key, value) pairs indexed by
iter in the object at the top of the stack. Use SETITEMS if possible,
but append no more than BatchSize items at a time.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.BatchSetItems(IronPython.Runtime.CodeContext,System.Collections.IEnumerator)">
<summary>
Emit a series of opcodes that will set all (key, value) pairs indexed by
iter in the object at the top of the stack. Use SETITEMS if possible,
but append no more than BatchSize items at a time.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.PicklerObject.FindModuleForGlobal(IronPython.Runtime.CodeContext,System.Object,System.Object)">
<summary>
Find the module for obj and ensure that obj is reachable in that module by the given name.
Throw PicklingError if any of the following are true:
- The module couldn't be determined.
- The module couldn't be loaded.
- The given name doesn't exist in the module.
- The given name is a different object than obj.
Otherwise, return the name of the module.
To determine which module obj lives in, obj.__module__ is used if available. The
module named by obj.__module__ is loaded if needed. If obj has no __module__
attribute, then each loaded module is searched. If a loaded module has an
attribute with the given name, and that attribute is the same object as obj,
then that module is used.
</summary>
</member>
<member name="M:IronPython.Modules.PythonPickle.UnpicklerObject.SetItems(IronPython.Runtime.PythonDictionary,System.Int32)">
<summary>
Interpret everything from markIndex to the top of the stack as a sequence
of key, value, key, value, etc. Set dict[key] = value for each. Pop
everything from markIndex up when done.
</summary>
</member>
<member name="M:IronPython.Modules.PythonDateTime.date.CheckType(System.Object,System.Boolean)">
<summary>
Used to check the type to see if we can do a comparison. Returns true if we can
or false if we should return NotImplemented. May throw if the type's really wrong.
</summary>
</member>
<member name="M:IronPython.Modules.PythonDateTime.time.CompareTo(System.Object)">
<summary>
Helper function for doing the comparisons. time has no __cmp__ method
</summary>
</member>
<member name="T:IronPython.Modules.PythonIterTools.IterBase">
<summary>
Base class used for iterator wrappers.
</summary>
</member>
<member name="M:IronPython.Modules.PythonMath.erf(System.Double)">
<summary>
Error function on real values
</summary>
</member>
<member name="M:IronPython.Modules.PythonMath.erfc(System.Double)">
<summary>
Complementary error function on real values: erfc(x) = 1 - erf(x)
</summary>
</member>
<member name="M:IronPython.Modules.PythonMath.gamma(System.Double)">
<summary>
Gamma function on real values
</summary>
</member>
<member name="M:IronPython.Modules.PythonMath.lgamma(System.Double)">
<summary>
Natural log of absolute value of Gamma function
</summary>
</member>
<member name="T:IronPython.Modules.ModuleOps">
<summary>
Provides helper functions which need to be called from generated code to implement various
portions of modules.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.access(IronPython.Runtime.CodeContext,System.String,System.Int32)">
<summary>
Checks for the specific permissions, provided by the mode parameter, are available for the provided path. Permissions can be:
F_OK: Check to see if the file exists
R_OK | W_OK | X_OK: Check for the specific permissions. Only W_OK is respected.
</summary>
</member>
<member name="F:IronPython.Modules.PythonNT.environ">
<summary>
single instance of environment dictionary is shared between multiple runtimes because the environment
is shared by multiple runtimes.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.lstat(System.String)">
<summary>
lstat(path) -> stat result
Like stat(path), but do not follow symbolic links.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.spawnl(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object[])">
<summary>
spawns a new process.
If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
is the exit code.
Otherwise the call returns a handle to the process. The caller must then call nt.waitpid(pid, options)
to free the handle and get the exit code of the process. Failure to call nt.waitpid will result
in a handle leak.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.spawnle(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object[])">
<summary>
spawns a new process.
If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
is the exit code.
Otherwise the call returns a handle to the process. The caller must then call nt.waitpid(pid, options)
to free the handle and get the exit code of the process. Failure to call nt.waitpid will result
in a handle leak.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.spawnv(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object)">
<summary>
spawns a new process.
If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
is the exit code.
Otherwise the call returns a handle to the process. The caller must then call nt.waitpid(pid, options)
to free the handle and get the exit code of the process. Failure to call nt.waitpid will result
in a handle leak.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.spawnve(IronPython.Runtime.CodeContext,System.Int32,System.String,System.Object,System.Object)">
<summary>
spawns a new process.
If mode is nt.P_WAIT then then the call blocks until the process exits and the return value
is the exit code.
Otherwise the call returns a handle to the process. The caller must then call nt.waitpid(pid, options)
to free the handle and get the exit code of the process. Failure to call nt.waitpid will result
in a handle leak.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.SetEnvironment(System.Collections.Specialized.StringDictionary,System.Object)">
<summary>
Copy elements from a Python mapping of dict environment variables to a StringDictionary.
</summary>
</member>
<member name="M:IronPython.Modules.PythonNT.ArgumentsToString(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Convert a sequence of args to a string suitable for using to spawn a process.
</summary>
</member>
<member name="T:IronPython.Modules.PythonRegex">
<summary>
Python regular expression module.
</summary>
</member>
<member name="T:IronPython.Modules.PythonRegex.RE_Pattern">
<summary>
Compiled reg-ex pattern
</summary>
</member>
<member name="M:IronPython.Modules.PythonRegex.PreParseRegex(IronPython.Runtime.CodeContext,System.String,System.Boolean)">
<summary>
Preparses a regular expression text returning a ParsedRegex class
that can be used for further regular expressions.
</summary>
</member>
<member name="T:IronPython.Modules.ResourceMetaPathImporter">
<summary>
Implementes a resource-based meta_path importer as described in PEP 302.
</summary>
</member>
<member name="M:IronPython.Modules.ResourceMetaPathImporter.#ctor(System.Reflection.Assembly,System.String)">
<summary>
Instantiates a new meta_path importer using an embedded ZIP resource file.
</summary>
<param name="fromAssembly"></param>
<param name="resourceName"></param>
</member>
<member name="M:IronPython.Modules.PythonSelect.ProcessSocketSequence(IronPython.Runtime.CodeContext,System.Object,IronPython.Runtime.List@,System.Collections.Generic.Dictionary{System.Net.Sockets.Socket,System.Object}@)">
<summary>
Process a sequence of objects that are compatible with ObjectToSocket(). Return two
things as out params: an in-order List of sockets that correspond to the original
objects in the passed-in sequence, and a mapping of these socket objects to their
original objects.
The socketToOriginal mapping is generated because the CPython select module supports
passing to select either file descriptor numbers or an object with a fileno() method.
We try to be faithful to what was originally requested when we return.
</summary>
</member>
<member name="M:IronPython.Modules.PythonSelect.ObjectToSocket(IronPython.Runtime.CodeContext,System.Object)">
<summary>
Return the System.Net.Sockets.Socket object that corresponds to the passed-in
object. obj can be a System.Net.Sockets.Socket, a PythonSocket.SocketObj, a
long integer (representing a socket handle), or a Python object with a fileno()
method (whose result is used to look up an existing PythonSocket.SocketObj,
which is in turn converted to a Socket.
</summary>
</member>
<member name="M:IronPython.Modules.PythonThread.interrupt_main(IronPython.Runtime.CodeContext)">
<summary>
Stops execution of Python or other .NET code on the main thread. If the thread is
blocked in native code the thread will be interrupted after it returns back to Python
or other .NET code.
</summary>
</member>
<member name="T:IronPython.Modules.PythonThread._local.ThreadLocalDictionaryStorage">
<summary>
Provides a dictionary storage implementation whose storage is local to
the thread.
</summary>
</member>
<member name="T:IronPython.Modules.PythonTime.FoundDateComponents">
<summary>
Represents the date components that we found while parsing the date. Used for zeroing out values
which have different defaults from CPython. Currently we only know that we need to do this for
the year.
</summary>
</member>
<member name="T:IronPython.Modules.xxsubtype">
<summary>
Samples on how to subtype built-in types from C#
</summary>
</member>
<member name="P:IronPython.Modules.xxsubtype.spamlist.state">
<summary>
an int variable for demonstration purposes
</summary>
</member>
<member name="P:IronPython.Modules.xxsubtype.spamdict.state">
<summary>
an int variable for demonstration purposes
</summary>
</member>
<member name="T:IronPython.Modules.PythonIOModule.BytesIO">
<summary>
BytesIO([initializer]) -> object
Create a buffered I/O implementation using an in-memory bytes
buffer, ready for reading and writing.
</summary>
</member>
<member name="M:IronPython.Modules.PythonIOModule.BytesIO.close(IronPython.Runtime.CodeContext)">
<summary>
close() -> None. Disable all I/O operations.
</summary>
</member>
<member name="P:IronPython.Modules.PythonIOModule.BytesIO.closed">
<summary>
True if the file is closed.
</summary>
</member>
<member name="M:IronPython.Modules.PythonIOModule.BytesIO.getvalue">
<summary>
getvalue() -> bytes.
Retrieve the entire contents of the BytesIO object.
</summary>
</member>
<member name="M:IronPython.Modules.PythonIOModule.FileIO.StandardizeMode(System.String)">
<summary>
Remove all 'b's from mode string to simplify parsing
</summary>
</member>
<member name="M:IronPython.Modules.PythonIOModule.TextIOWrapper.ReadChunk(IronPython.Runtime.CodeContext)">
<summary>
Read and decode the next chunk from the buffered reader. Returns true if EOF was
not reached. Places decoded string in _decodedChars.
</summary>
</member>
<member name="M:IronPython.Modules.PythonIOModule.GetBytes(System.Object,System.String)">
<summary>
Convert string or bytes into bytes
</summary>
</member>
<member name="M:IronPython.Modules.PythonIOModule.GetBytes(System.Object)">
<summary>
Convert most bytearray-like objects into IList of byte
</summary>
</member>
<member name="M:IronPython.Modules.PythonCodecs.charmap_build(System.String)">
<summary>
Creates an optimized encoding mapping that can be consumed by an optimized version of charmap_encode.
</summary>
</member>
<member name="M:IronPython.Modules.PythonCodecs.charmap_encode(IronPython.Runtime.CodeContext,System.String,System.String,IronPython.Modules.EncodingMap)">
<summary>
Encodes the input string with the specified optimized encoding map.
</summary>
</member>
<member name="M:IronPython.Modules.PythonCodecs.charmap_decode(IronPython.Runtime.CodeContext,System.String,System.String,System.String)">
<summary>
Decodes the input string using the provided string mapping.
</summary>
</member>
<member name="T:IronPython.Modules.EncodingMap">
<summary>
Optimized encoding mapping that can be consumed by charmap_encode.
</summary>
</member>
<member name="M:IronPython.Modules.PythonCollections.deque.WalkDeque(IronPython.Modules.PythonCollections.deque.DequeWalker)">
<summary>
Walks the queue calling back to the specified delegate for
each populated index in the queue.
</summary>
</member>
<member name="M:IronPython.Modules.PythonCsvModule.GetDialects(IronPython.Runtime.CodeContext)">
<summary>
Returns the dialects from the code context.
</summary>
<param name="context"></param>
<returns></returns>
</member>
<member name="T:IronPython.Modules.CTypes">
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
<summary>
Provides support for interop with native code from Python code.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.ArrayType">
<summary>
The meta class for ctypes array instances.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.ArrayType.from_param(System.Object)">
<summary>
Converts an object into a function call parameter.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.CData">
<summary>
Base class for all ctypes interop types.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(IronPython.Runtime.PythonTuple)">
<summary>
Creates a new CFuncPtr object from a tuple. The 1st element of the
tuple is the ordinal or function name. The second is an object with
a _handle property. The _handle property is the handle of the module
from which the function will be loaded.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(System.Int32,System.String)">
<summary>
Creates a new CFuncPtr which calls a COM method.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(System.Int32)">
<summary>
Creates a new CFuncPtr with the specfied address.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.#ctor(System.Numerics.BigInteger)">
<summary>
Creates a new CFuncPtr with the specfied address.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.AddKeepAlives(IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller[],System.Collections.Generic.List{System.Linq.Expressions.Expression})">
<summary>
we need to keep alive any methods which have arguments for the duration of the
call. Otherwise they could be collected on the finalizer thread before we come back.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.CreateInteropInvoker(System.Runtime.InteropServices.CallingConvention,IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller[],IronPython.Modules.CTypes.INativeType,System.Boolean,System.Collections.Generic.List{System.Object})">
<summary>
Creates a method for calling with the specified signature. The returned method has a signature
of the form:
(IntPtr funcAddress, arg0, arg1, ..., object[] constantPool)
where IntPtr is the address of the function to be called. The arguments types are based upon
the types that the ArgumentMarshaller requires.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller">
<summary>
Base class for marshalling arguments from the user provided value to the
call stub. This class provides the logic for creating the call stub and
calling it.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller.EmitCallStubArgument(System.Reflection.Emit.ILGenerator,System.Int32,System.Collections.Generic.List{System.Object},System.Int32)">
<summary>
Emits the IL to get the argument for the call stub generated into
a dynamic method.
</summary>
</member>
<member name="P:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller.ArgumentExpression">
<summary>
Gets the expression used to provide the argument. This is the expression
from an incoming DynamicMetaObject.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes._CFuncPtr.Meta.ArgumentMarshaller.GetKeepAlive">
<summary>
Gets an expression which keeps alive the argument for the duration of the call.
Returns null if a keep alive is not necessary.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.PrimitiveMarshaller">
<summary>
Provides marshalling of primitive values when the function type
has no type information or when the user has provided us with
an explicit cdata instance.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.CDataMarshaller">
<summary>
Provides marshalling for when the function type provide argument information.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes._CFuncPtr.Meta.NativeArgumentMarshaller">
<summary>
Provides marshalling for when the user provides a native argument object
(usually gotten by byref or pointer) and the function type has no type information.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.CFuncPtrType">
<summary>
The meta class for ctypes function pointer instances.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.CFuncPtrType.from_param(System.Object)">
<summary>
Converts an object into a function call parameter.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.Field">
<summary>
Fields are created when a Structure is defined and provide
introspection of the structure.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.Field.ExtractBits(System.Object)">
<summary>
Called for fields which have been limited to a range of bits. Given the
value for the full type this extracts the individual bits.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.Field.SetBitsValue(IronPython.Modules.MemoryHolder,System.Int32,System.Object)">
<summary>
Called for fields which have been limited to a range of bits. Sets the
specified value into the bits for the field.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.INativeType">
<summary>
Common functionality that all of the meta classes provide which is part of
our implementation. This is used to implement the serialization/deserialization
of values into/out of memory, emit the marshalling logic for call stubs, and
provide common information (size/alignment) for the types.
</summary>
</member>
<member name="P:IronPython.Modules.CTypes.INativeType.Size">
<summary>
Gets the native size of the type
</summary>
</member>
<member name="P:IronPython.Modules.CTypes.INativeType.Alignment">
<summary>
Gets the required alignment for the type
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.INativeType.GetValue(IronPython.Modules.MemoryHolder,System.Object,System.Int32,System.Boolean)">
<summary>
Deserialized the value of this type from the given address at the given
offset. Any new objects which are created will keep the provided
MemoryHolder alive.
raw determines if the cdata is returned or if the primitive value is
returned. This is only applicable for subtypes of simple cdata types.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.INativeType.SetValue(IronPython.Modules.MemoryHolder,System.Int32,System.Object)">
<summary>
Serializes the provided value into the specified address at the given
offset.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.INativeType.GetNativeType">
<summary>
Gets the .NET type which is used when calling or returning the value
from native code.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.INativeType.GetPythonType">
<summary>
Gets the .NET type which the native type is converted into when going to Python
code. This is usually int, BigInt, double, object, or a CData type.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.INativeType.EmitMarshalling(System.Reflection.Emit.ILGenerator,IronPython.Modules.LocalOrArg,System.Collections.Generic.List{System.Object},System.Int32)">
<summary>
Emits marshalling of an object from Python to native code. This produces the
native type from the Python type.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.INativeType.EmitReverseMarshalling(System.Reflection.Emit.ILGenerator,IronPython.Modules.LocalOrArg,System.Collections.Generic.List{System.Object},System.Int32)">
<summary>
Emits marshalling from native code to Python code This produces the python type
from the native type. This is used for return values and parameters
to Python callable objects that are passed back out to native code.
</summary>
</member>
<member name="P:IronPython.Modules.CTypes.INativeType.TypeFormat">
<summary>
Returns a string which describes the type. Used for _buffer_info implementation which
only exists for testing purposes.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.PointerType">
<summary>
The meta class for ctypes pointers.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.PointerType.from_param(IronPython.Modules.CTypes.Pointer)">
<summary>
Converts an object into a function call parameter.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.PointerType.from_address(System.Object)">
<summary>
Access an instance at the specified address
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.SimpleType">
<summary>
The meta class for ctypes simple data types. These include primitives like ints,
floats, etc... char/wchar pointers, and untyped pointers.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.SimpleType.from_param(System.Object)">
<summary>
Converts an object into a function call parameter.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.SimpleType.ReadChar(IronPython.Modules.MemoryHolder,System.Int32)">
<summary>
Helper function for reading char/wchar's. This is used for reading from
arrays and pointers to avoid creating lots of 1-char strings.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.SimpleTypeKind">
<summary>
The enum used for tracking the various ctypes primitive types.
</summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Char">
<summary> 'c' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedByte">
<summary> 'b' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedByte">
<summary> 'B' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedShort">
<summary> 'h' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedShort">
<summary> 'H' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedInt">
<summary> 'i' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedInt">
<summary> 'I' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedLong">
<summary> 'l' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedLong">
<summary> 'L' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Single">
<summary> 'f' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Double">
<summary> 'd', 'g' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.SignedLongLong">
<summary> 'q' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.UnsignedLongLong">
<summary> 'Q' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Object">
<summary> 'O' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Pointer">
<summary> 'P' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.CharPointer">
<summary> 'z' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.WCharPointer">
<summary> 'Z' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.WChar">
<summary> 'u' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.Boolean">
<summary> '?' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.VariantBool">
<summary> 'v' </summary>
</member>
<member name="F:IronPython.Modules.CTypes.SimpleTypeKind.BStr">
<summary> 'X' </summary>
</member>
<member name="T:IronPython.Modules.CTypes.StructType">
<summary>
Meta class for structures. Validates _fields_ on creation, provides factory
methods for creating instances from addresses and translating to parameters.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.StructType.from_param(System.Object)">
<summary>
Converts an object into a function call parameter.
Structures just return themselves.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.StructType.EnsureSizeAndAlignment">
<summary>
If our size/alignment hasn't been initialized then grabs the size/alignment
from all of our base classes. If later new _fields_ are added we'll be
initialized and these values will be replaced.
</summary>
</member>
<member name="T:IronPython.Modules.CTypes._Structure">
<summary>
Base class for data structures. Subclasses can define _fields_ which
specifies the in memory layout of the values. Instances can then
be created with the initial values provided as the array. The values
can then be accessed from the instance by field name. The value can also
be passed to a foreign C API and the type can be used in other structures.
class MyStructure(Structure):
_fields_ = [('a', c_int), ('b', c_int)]
MyStructure(1, 2).a
MyStructure()
class MyOtherStructure(Structure):
_fields_ = [('c', MyStructure), ('b', c_int)]
MyOtherStructure((1, 2), 3)
MyOtherStructure(MyStructure(1, 2), 3)
</summary>
</member>
<member name="T:IronPython.Modules.CTypes.UnionType">
<summary>
The meta class for ctypes unions.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.UnionType.from_param(System.Object)">
<summary>
Converts an object into a function call parameter.
</summary>
</member>
<member name="P:IronPython.Modules.CTypes._cast_addr">
<summary>
Gets a function which casts the specified memory. Because this is used only
w/ Python API we use a delegate as the return type instead of an actual address.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.Cast(System.IntPtr,System.IntPtr,System.IntPtr)">
<summary>
Implementation of our cast function. data is marshalled as a void*
so it ends up as an address. obj and type are marshalled as an object
so we need to unmarshal them.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.POINTER(IronPython.Runtime.CodeContext,IronPython.Runtime.Types.PythonType)">
<summary>
Returns a new type which represents a pointer given the existing type.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.PyObj_FromPtr(System.IntPtr)">
<summary>
Converts an address acquired from PyObj_FromPtr or that has been
marshaled as type 'O' back into an object.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.PyObj_ToPtr(System.Object)">
<summary>
Converts an object into an opaque address which can be handed out to
managed code.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.Py_DECREF(System.Object)">
<summary>
Decreases the ref count on an object which has been increased with
Py_INCREF.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.Py_INCREF(System.Object)">
<summary>
Increases the ref count on an object ensuring that it will not be collected.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.addressof(IronPython.Modules.CTypes.CData)">
<summary>
returns address of C instance internal buffer.
It is the callers responsibility to ensure that the provided instance will
stay alive if memory in the resulting address is to be used later.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.alignment(IronPython.Runtime.Types.PythonType)">
<summary>
Gets the required alignment of the given type.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.alignment(System.Object)">
<summary>
Gets the required alignment of an object.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.pointer(IronPython.Runtime.CodeContext,IronPython.Modules.CTypes.CData)">
<summary>
Returns a pointer instance for the given CData
</summary>
</member>
<member name="P:IronPython.Modules.CTypes.DynamicModule">
<summary>
Gets the ModuleBuilder used to generate our unsafe call stubs into.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.GetMarshalTypeFromSize(System.Int32)">
<summary>
Given a specific size returns a .NET type of the equivalent size that
we can use when marshalling these values across calls.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.GetFieldInfo(IronPython.Modules.CTypes.INativeType,System.Object,System.String@,IronPython.Modules.CTypes.INativeType@,System.Nullable{System.Int32}@)">
<summary>
Shared helper between struct and union for getting field info and validating it.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.CheckBits(IronPython.Modules.CTypes.INativeType,IronPython.Runtime.PythonTuple)">
<summary>
Verifies that the provided bit field settings are valid for this type.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.GetFieldsList(System.Object)">
<summary>
Shared helper to get the _fields_ list for struct/union and validate it.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.StringAt(System.IntPtr,System.Int32)">
<summary>
Helper function for translating from memset to NT's FillMemory API.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.WStringAt(System.IntPtr,System.Int32)">
<summary>
Helper function for translating from memset to NT's FillMemory API.
</summary>
</member>
<member name="M:IronPython.Modules.CTypes.EmitCDataCreation(IronPython.Modules.CTypes.INativeType,System.Reflection.Emit.ILGenerator,System.Collections.Generic.List{System.Object},System.Int32)">
<summary>
Emits the marshalling code to create a CData object for reverse marshalling.
</summary>
</member>
<member name="T:IronPython.Modules.LocalOrArg">
<summary>
Wrapper class for emitting locals/variables during marshalling code gen.
</summary>
</member>
<member name="T:IronPython.Modules.MemoryHolder">
<summary>
A wrapper around allocated memory to ensure it gets released and isn't accessed
when it could be finalized.
</summary>
</member>
<member name="M:IronPython.Modules.MemoryHolder.#ctor(System.Int32)">
<summary>
Creates a new MemoryHolder and allocates a buffer of the specified size.
</summary>
</member>
<member name="M:IronPython.Modules.MemoryHolder.#ctor(System.IntPtr,System.Int32)">
<summary>
Creates a new MemoryHolder at the specified address which is not tracked
by us and we will never free.
</summary>
</member>
<member name="M:IronPython.Modules.MemoryHolder.#ctor(System.IntPtr,System.Int32,IronPython.Modules.MemoryHolder)">
<summary>
Creates a new MemoryHolder at the specified address which will keep alive the
parent memory holder.
</summary>
</member>
<member name="P:IronPython.Modules.MemoryHolder.UnsafeAddress">
<summary>
Gets the address of the held memory. The caller should ensure the MemoryHolder
is always alive as long as the address will continue to be accessed.