From 0f69d56cad12667bb3cb76a5f4ff77ffa6b12451 Mon Sep 17 00:00:00 2001 From: Haxe CI Bot Date: Thu, 16 May 2024 14:01:54 +0000 Subject: [PATCH] import xml doc of development (01e2014d0bd8c894ad24745c15228d72b8f19a5c) --- xml/development/cpp.xml | 513 +++++++++++++++++++++++++++++--------- xml/development/info.json | 2 +- 2 files changed, 394 insertions(+), 121 deletions(-) diff --git a/xml/development/cpp.xml b/xml/development/cpp.xml index 37560f3e0a71..104cd996e0c7 100644 --- a/xml/development/cpp.xml +++ b/xml/development/cpp.xml @@ -712,36 +712,55 @@ - ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"] + + ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"] + + - ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"] + + ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"] + + - ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"] + + ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"] + + - ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"] + + ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"] + + - <__format_get set="method" line="44" static="1"> - - - - - <__format set="method" line="105" static="1"> - - - - + <__format_get set="method" line="44" static="1"> + + + + + + + + <__format set="method" line="105" static="1"> + + + + + + + + Format the date `d` according to the format `f`. The format is compatible with the `strftime` standard format, except that there is no support in Flash and JS for day and months names (due to lack of proper @@ -768,6 +787,7 @@ + Returns the result of adding timestamp `t` to Date `d`. This is a convenience function for calling @@ -775,13 +795,17 @@ - [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31] + + [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31] + + + Returns the number of days in the month of Date `d`. This method handles leap years. @@ -791,6 +815,7 @@ + Converts a number of seconds to a timestamp. @@ -798,6 +823,7 @@ + Converts a number of minutes to a timestamp. @@ -805,6 +831,7 @@ + Converts a number of hours to a timestamp. @@ -812,6 +839,7 @@ + Converts a number of days to a timestamp. @@ -825,6 +853,7 @@ + Separate a date-time into several components @@ -838,6 +867,7 @@ + Build a date-time from several components @@ -850,7 +880,10 @@ - + + + + Retrieve Unix timestamp value from Date components. Takes same argument sequence as the Date constructor. The DateTools class contains some extra functionalities for handling `Date` @@ -1160,6 +1193,10 @@ + + + + Matches enum instance `e` against pattern `pattern`, returning `true` if matching succeeded and `false` otherwise. @@ -1194,6 +1231,10 @@ + + + + Matches enum instance `e` against pattern `pattern`, returning `true` if matching succeeded and `false` otherwise. @@ -2402,6 +2443,7 @@ @see https://haxe.org/manual/std-math-integer-math.html @see https://haxe.org/manual/types-nullability.html]]> + @@ -6049,13 +6091,19 @@ - + + + + - { inPin : false } + + { inPin : false } + + This is just a helper class. It is not actually required to inherit from this to use `NativeGc.addFinalizable(this,inPin)`, only a function called @@ -7220,6 +7268,7 @@ "__hxcpp_set_minimum_working_memory" + @@ -10370,68 +10419,119 @@ If you implement this interface, then the backend will generate code that allows fast numeric access to fields by integer id. This should speed up the CFFI. - - - - - - - + + + + + + + + + + + + + + + + Parameter describes a function parameter. Instances of this class are embedded in stack frame objects to describe the function parameters that were used in the invocation of the function that defines that stack frame. + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + `StackFrame` describes one call stack frame. + - 1 + + 1 + + - 2 + + 2 + + - 3 + + 3 + + - 4 + + 4 + + - 5 + + 5 + + + 0 is never a valid thread number - + + + + + If status is "stopped breakpoint", this is the breakpoint number + If status is "critical error", this describes the error + Stack will be listed with the lowest frame first @@ -10442,49 +10542,80 @@ - { criticalErrorDescription : null, breakpoint : -1 } + + { criticalErrorDescription : null, breakpoint : -1 } + + `ThreadInfo` describes the state of a single thread. + - 1 + + 1 + + - 2 + + 2 + + - 3 + + 3 + + - 4 + + 4 + + - 1 + + 1 + + - 2 + + 2 + + - 3 + + 3 + + - "NONEXISTENT_VALUE" + + "NONEXISTENT_VALUE" + + This tagging value is returned by `getStackVariableValue()` and `setStackVariableValue()` if the requested value does not exist at the requested stack frame - "THREAD_NOT_STOPPED" + + "THREAD_NOT_STOPPED" + + This tagging value is returned by `getStackVariableValue()` and `setStackVariableValue()` if the stack variable that is being set is on a thread that is running, in which case the set does not take place. @@ -10503,7 +10634,10 @@ - + + + + Sets the handler callback to be made when asynchronous events occur, specifically, when threads are created, terminated, started, or stopped. The calling thread becomes the "debugger" thread, which means @@ -10542,7 +10676,10 @@ - + + + + This can be called to turn off (and then back on) all stopping of debugged threads temporarily. It should only be used by classes that actually implement the debugger to hide themselves from the debugger as @@ -10550,14 +10687,20 @@ - + + + + Returns the thread number of the calling thread. @return the thread number of the calling thread. - + + + + Returns the set of source files known to the debugger. This is a copy of the original array and could be quite large. The caller should cache this value to avoid multiple copies needing to be made. @@ -10566,7 +10709,10 @@ - + + + + Returns the full paths of the set of source files known to the debugger. This is a copy of the original array and could be quite large. It is possible that this set will be empty, in which case the full paths are not known. @@ -10577,7 +10723,10 @@ - + + + + Returns the set of class names of all classes known to the debugger. This is a copy of the original array and could be quite large. The caller should cache this value to avoid multiple copies needing to be @@ -10587,7 +10736,10 @@ - + + + + Returns a `ThreadInfo` object describing every thread that existed at the moment that the call was made, except for the debugger thread. @@ -10597,7 +10749,10 @@ - + + + + Returns a `ThreadInfo` object describing a single thread, or `null` if there is no such thread or the thread queried about was the debugger thread and `unsafe` was not `true`. @@ -10608,7 +10763,10 @@ - + + + + Adds a new `file:line` breakpoint. The breakpoint number of the newly added breakpoint is returned. @@ -10618,7 +10776,10 @@ - + + + + Adds a new `class:function` breakpoint. The breakpoint number of the newly added breakpoint is returned. @@ -10627,7 +10788,10 @@ - + + + + Deletes a breakpoint, or all breakpoints. @@ -10638,6 +10802,7 @@ { wait : true } + Breaks all threads except the debugger thread (which should be the same as the calling thread!). @@ -10652,7 +10817,10 @@ - + + + + Continue execution of all stopped threads. If `specialThreadNumber` is a valid thread number, then it will be continued past `continueCount` breakpoints instead of just 1 like all of the other @@ -10668,6 +10836,7 @@ { stepCount : 1 } + Single steps the given thread. @@ -10678,7 +10847,10 @@ - + + + + Returns the list of local variables (including `this`, function arguments, and local variables) visible to the given thread at the given stack frame. @@ -10699,7 +10871,10 @@ - + + + + Returns the value of a stack variable, or `NONEXISTENT_VALUE` if the requested value does not exist. If the thread is actively running and `unsafe` is not `true`, returns `THREAD_NOT_STOPPED`. @@ -10713,7 +10888,10 @@ - + + + + Sets the value of a stack variable and returns that value. If the variable does not exist, on the stack, this function returns `NONEXISTENT_VALUE`. If the thread is actively running and `unsafe` is not @@ -10729,39 +10907,61 @@ - + + + + - + + + + - + + + + - 0 + + 0 + + - 1 + + 1 + + - 2 + + 2 + + - 3 + + 3 + + + Introduced hxcpp_api_level 310 Returns stats on memory usage: @@ -10771,49 +10971,94 @@ This will generally saw-tooth between USAGE and RESERVED - `MEM_INFO_LARGE` - Size of separate pool used for large allocs. Included in all the above. - - - - - - + + + + + + + + + + + + + + + - { printInstances : true } + + { printInstances : true } + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -10823,7 +11068,10 @@ - "__hxcpp_set_finalizer" + + + "__hxcpp_set_finalizer" + @@ -10840,11 +11088,17 @@ - + + + + - + + + + @@ -10861,23 +11115,41 @@ - + + + + - - + + + + + + + + - + + + + - + + + + - + + + + @@ -10887,6 +11159,7 @@ { inHard : false } + diff --git a/xml/development/info.json b/xml/development/info.json index c920f7eb3e2c..27b1594ebfdd 100644 --- a/xml/development/info.json +++ b/xml/development/info.json @@ -1,4 +1,4 @@ { - "commit": "7675bb26c7bd0df85575a673377a802913890872", + "commit": "01e2014d0bd8c894ad24745c15228d72b8f19a5c", "branch": "development" }