autodoc.git
/
traditional.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional.xml:1:
<?xml version='1.0' encoding='utf-8'?>
-
<manual time-stamp='2022-
08
-
28
' version='Pike v8.1.18'>
+
<manual time-stamp='2022-
09
-
06
' version='Pike v8.1.18'>
<dir name='./traditional_manual'> <file name='./traditional_manual/index.html'> <chapter title='Table of Contents' unnumbered='1'> <dl><dt><url href='index.html'>Table of Contents</url></dt> <dt><url href='chapter_1.html'>1. Introduction</url></dt> <dd><url href='chapter_1.html#1.1'>1.1. Overview</url></dd> <dd><url href='chapter_1.html#1.2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#1.3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#1.4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#1.5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:6168:
the variable initialization expressions in this class, in the order they occur.</p> </text><group><note/><text><p>This function can not be overloaded or blocked from executing.</p> </text></group><group><seealso/><text><p><ref resolved='lfun::create'>lfun::create()</ref></p> </text></group></doc> <method name='__INIT'> <arguments/> <returntype><void/></returntype> </method> </docgroup>
+
<docgroup homogen-name='__create__' homogen-type='method'><doc><text><p>Low-level object creation callback.</p>
+
<p> This function is generated automatically by the compiler for
+
inline classes that declare parameters. A call to it and its
+
arguments are automatically added to user-supplied <ref resolved='lfun::create'>lfun::create()</ref></p>
+
</text><group><note/><text><p>This function is typically created implicitly
+
by the compiler using the syntax:</p>
+
<code><text><p>class Foo(int foo) {
+
int bar;
+
}</p>
+
</text></code><p>In the above case an implicit <ref resolved='lfun::__create__'>lfun::__create__()</ref> is created, and
+
it's equivalent to:</p>
+
<code><text><p>class Foo {
+
int foo;
+
int bar;
+
local protected void __create__(int foo)
+
{
+
this::foo = foo;
+
}
+
}</p>
+
</text></code>
+
</text></group><group><note/><text><p>Note also that in case <ref resolved='lfun::create'>lfun::create()</ref> does not exist,
+
this function will be called instead.</p>
+
</text></group><group><note/><text><p>This function did not exist in Pike 8.0 and earlier (where it
+
was instead automatically inlined in <ref resolved='lfun::create'>lfun::create()</ref>.</p>
+
</text></group><group><seealso/><text><p><ref resolved='lfun::create'>lfun::create()</ref>, <ref resolved='lfun::__INIT'>lfun::__INIT()</ref></p>
+
</text></group></doc>
+
<method name='__create__'>
+
<arguments><argument name='args'><type><varargs><object>__unknown__</object></varargs></type></argument></arguments>
+
<returntype><void/></returntype>
+
</method>
+
</docgroup>
<docgroup homogen-name='__hash' homogen-type='method'><doc><text><p>Hashing callback.</p> <p> The main caller of this function is <ref resolved='predef::hash_value'>predef::hash_value()</ref> or the low-level equivalent, which get called by various mapping operations when the object is used as index in a mapping.</p> </text><group><returns/><text><p>It should return an integer that corresponds to the object in such a way that all values which <ref resolved='lfun::`=='>lfun::`==</ref> considers equal to the object get the same hash value.</p> </text></group><group><note/><text><p>The function <ref resolved='predef::hash'>predef::hash</ref> does not return hash values that are compatible with this one.</p> </text></group><group><note/><text><p>It's assumed that this function is side-effect free.</p>
autodoc.git/traditional.xml:7017:
</text></group><group><note/><text><p>It's assumed that this function is side-effect free.</p> </text></group></doc> <method name='cast'> <arguments><argument name='requested_type'><type><string/></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Object creation callback.</p> <p> This function is called right after <ref resolved='lfun::__INIT'>lfun::__INIT()</ref>.</p> <p> <ref resolved='lfun::create.args'>args</ref> are the arguments passed when the program was called.</p>
-
</text><group><note/><text><p>
This
function
can
be
created
implicitly
-
by
the
compiler
using
the
syntax
:</
p
>
-
<
code
><
text
>
<p>class
Foo(int
foo)
{
-
int
bar;
-
}
</p>
-
</text></
code
><p>In the
above
case
an
implicit
<ref resolved='lfun::create'>lfun::create()</ref>
is
created,
and
-
it's
equivalent
to
:</p>
-
<
code
><text><p>
class
Foo
{
-
int
foo;
-
int bar;
-
protected void
create(
int foo
)
-
{
-
this::foo
= foo;
-
}
-
}
</p>
-
</text></
code>
-
</text></
group><group><seealso/><text><p><ref resolved='lfun::__INIT'>lfun::__INIT()</ref>, <ref resolved='lfun::_destruct'>lfun::_destruct()</ref></p>
+
</text><group><note/><text><p>
If
there
exists
an
implicitly
created
<ref resolved='lfun::__create__'>lfun::__create__()</ref>
+
its
arguments
will
be
prepended
to <ref resolved='lfun
:
:create.args'>args
</
ref
>
(affecting the
+
prototype for
<
ref resolved='lfun::create'
>
lfun::create()
<
/ref
>
),
and
a
call
to
it
will
be
+
prepended to the code of
<
ref resolved='lfun::create'>lfun::create()<
/
ref>.</
p>
+
</text></
group
><
group><note/><text><
p>In
Pike 8.0 and earlier
the
code
equivalent
to
+
<ref resolved='lfun::
__
create
__
'>lfun::
__
create
__
()</ref>
was
inlined
at the beginning
+
of
<ref
resolved='lfun
:
:create'>lfun::create()
</
ref>.</
p>
+
<
/text
><
/group><group><note/><
text><p>
If
this
function
does
not
exist,
but
<ref
resolved='lfun::__
create
__'>lfun::__create__
()
</ref>
+
does,
it
will
instead
be
called
directly.
</p>
+
</text></group><group><seealso/><text><p><ref resolved='lfun::__
create__'>lfun::__create__()</ref>, <ref resolved='lfun::__
INIT'>lfun::__INIT()</ref>, <ref resolved='lfun::_destruct'>lfun::_destruct()</ref></p>
</text></group></doc> <method name='create'> <arguments><argument name='args'><type><varargs><zero/></varargs></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='symbol' homogen-type='variable'> <variable name='symbol'><type><mixed/></type></variable> </docgroup> </namespace></autodoc>