Difference between revisions of "Function/ru"

From Free Pascal wiki
Jump to navigationJump to search
Line 7: Line 7:
 
Слово <syntaxhighlight lang="pascal" inline>function</syntaxhighlight> является [[Reserved word|зарезервированным словом]].
 
Слово <syntaxhighlight lang="pascal" inline>function</syntaxhighlight> является [[Reserved word|зарезервированным словом]].
  
== Return value ==
+
== Возвращаемое значение ==
  
In addition to a normal procedure, a function’s formal signature contains a return [[Data type|type]]:
+
В дополнение к обычной процедуре формальная сигнатура функции содержит [[Data_type/ru|тип]] возвращаемого значения: список формальных параметров должен сопровождаться [[Colon|двоеточием]] и типом возвращаемого значения. Например, следующая функция возвращает  [[Boolean|<syntaxhighlight lang="pascal" inline>Boolean</syntaxhighlight>]]
The formal parameter list has to be succeeded by a [[Colon|colon]] and return type.
 
For instance the following function returns a [[Boolean|<syntaxhighlight lang="pascal" inline>Boolean</syntaxhighlight>]].
 
  
 
<syntaxhighlight lang="pascal">
 
<syntaxhighlight lang="pascal">
Line 17: Line 15:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
When implementing functions there are several ways to define the function’s return value.
+
При реализации функций есть несколько способов определить возвращаемое значение функции.
  
 
<syntaxhighlight lang="pascal" line highlight="10">
 
<syntaxhighlight lang="pascal" line highlight="10">
Line 24: Line 22:
 
{$mode objFPC}
 
{$mode objFPC}
  
// traditional syntax:
+
// традиционный синтаксис:
// the result is stored in the variable
+
// результат сохраняется в переменной
// its name is the same as the function's
+
// его имя такое же, как у функции
 
function myLine(const x: real): real;
 
function myLine(const x: real): real;
 
begin
 
begin
Line 33: Line 31:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
If <syntaxhighlight lang="pascal" inline>{$modeswitch result+}</syntaxhighlight>, which is set by [[Mode ObjFPC|<syntaxhighlight lang="pascal" inline>{$mode objFPC}</syntaxhighlight>]] and [[Mode Delphi|<syntaxhighlight lang="pascal" inline>{$mode Delphi}</syntaxhighlight>]], inside the implementation block the special [[Identifier|identifier]] <syntaxhighlight lang="pascal" inline>result</syntaxhighlight> is available, too:
+
Если <syntaxhighlight lang="pascal" inline>{$modeswitch result+}</syntaxhighlight>, заданный [[Mode ObjFPC|<syntaxhighlight lang="pascal" inline>{$mode objFPC}</syntaxhighlight>]] и [[Mode Delphi|<syntaxhighlight lang="pascal" inline>{$mode Delphi}</syntaxhighlight>]], внутри блока реализации также доступен результат специального идентификатора:
  
 
<syntaxhighlight lang="pascal" line start="13" highlight="4">
 
<syntaxhighlight lang="pascal" line start="13" highlight="4">
// using special `result` identifier
+
// используя специальный идентификатор `result`
 
function myParabola(const x: real): real;
 
function myParabola(const x: real): real;
 
begin
 
begin
Line 43: Line 41:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Additionally, in <syntaxhighlight lang="pascal" inline>{$mode objFPC}</syntaxhighlight> the routine {{Doc|package=RTL|unit=system|identifier=exit|text=<syntaxhighlight lang="pascal" inline>exit</syntaxhighlight>}} will set the return value, too, ''and'' leave the stack frame.
+
Кроме того, в <syntaxhighlight lang="pascal" inline>{$mode objFPC}</syntaxhighlight> подпрограмма {{Doc|package=RTL|unit=system|identifier=exit|text=<syntaxhighlight lang="pascal" inline>exit</syntaxhighlight>}} также установит возвращаемое значение ''и'' покинет стековый кадр. В предыдущих двух примерах могли появиться дополнительные операторы, и они были бы выполнены, уже после того, как <syntaxhighlight lang="pascal" inline>exit</syntaxhighlight> подпрограмма ''выполнится''. Это поведение оператора <syntaxhighlight lang="C" inline>return</syntaxhighlight> в C или других языках программирования.
In the previous two examples further statements could have appeared, and they would have been executed, whilst after an <syntaxhighlight lang="pascal" inline>exit</syntaxhighlight> the routine is ''done''.
 
This is the behavior a <syntaxhighlight lang="C" inline>return</syntaxhighlight> statement in C or other programming languages has.
 
  
 
<syntaxhighlight lang="pascal" line start="19" highlight="4">
 
<syntaxhighlight lang="pascal" line start="19" highlight="4">
// using exit routine
+
// использование процедуры выхода exit
 
function even(const x: longint): Boolean;
 
function even(const x: longint): Boolean;
 
begin
 
begin
exit(not odd(x));
+
  exit(not odd(x));
 
end;
 
end;
 
</syntaxhighlight>
 
</syntaxhighlight>
  
In [[Assembly language|assembly language]] other rules apply.
+
В языке [[Assembly language|ассемблера]] применяются другие правила. Если тип возвращаемого значения является целым числом, используется регистр-накопитель, при условии, что он помещается туда:
If the return type is an integral value, the accumulator register is used, provided it fits in there:
 
  
 
<syntaxhighlight lang="pascal" line start="25" highlight="9,12,23">
 
<syntaxhighlight lang="pascal" line start="25" highlight="9,12,23">
// in assembly language:
+
// на ассемблере:
// return type fits into a single register => use accumulator register
+
// возвращаемый тип умещается в один регистр => использовать регистр-накопитель
 
function zero(const x: int64): Boolean;
 
function zero(const x: int64): Boolean;
 
{$ifDef CPUx86_64}
 
{$ifDef CPUx86_64}
Line 66: Line 61:
 
{$asmMode intel}
 
{$asmMode intel}
 
asm
 
asm
// xor modifies flags => put it in front of test
+
// xor изменяет флаги => поместите его перед тестом
xor rax, rax    // rax := 0    (remove residue)
+
xor rax, rax    // rax := 0    (удалить остаток)
 
 
 
test x, x        // x = 0 ?
 
test x, x        // x = 0 ?
 
setz al          // rax := ZF
 
setz al          // rax := ZF
 
 
// When you examine the assembler output
+
        // Когда вы изучаете вывод ассемблера
// you will notice the compiler automatically inserts code
+
        // вы заметите, что компилятор автоматически вставляет код
// that moves the contents of rax to the right spot on the stack,
+
        // который перемещает содержимое rax в нужное место в стеке,
// unless the noStackFrame hint
+
        // пока не появится подсказка noStackFrame
// (automatically set by some optimization levels)
+
        // (автоматически устанавливается некоторыми уровнями оптимизации)
// instructs the compiler to omit the stack frame if possible.
+
        // инструктирует компилятор опустить кадр стека, если это возможно.
 
end;
 
end;
 
{$else}
 
{$else}
Line 86: Line 81:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Otherwise, depending on which [[sAsmmode|<syntaxhighlight lang="pascal" inline>{$asmMode}</syntaxhighlight>]] is active, the <syntaxhighlight lang="asm" inline>@result</syntaxhighlight> (Intel) or <syntaxhighlight lang="asm" inline>__result</syntaxhighlight> (AT&T) macro can be used.
+
В противном случае, в зависимости от того, какой режим [[sAsmmode|<syntaxhighlight lang="pascal" inline>{$asmMode}</syntaxhighlight>]] активен, можно использовать макрос <syntaxhighlight lang="asm" inline>@result</syntaxhighlight> (Intel) или <syntaxhighlight lang="asm" inline>__result</syntaxhighlight> (AT&T).
  
 
<syntaxhighlight lang="pascal" line start="51" highlight="20,31,36,40,41">
 
<syntaxhighlight lang="pascal" line start="51" highlight="20,31,36,40,41">
Line 95: Line 90:
 
end;
 
end;
  
// in assembly language:
+
// на ассемблере:
// return type doesn't fit into accumulator => @result macro gives address
+
// возвращаемый тип не помещается в аккумулятор => макрос @result дает адрес
 
function sphere(const radius: real): bodyAttributes;
 
function sphere(const radius: real): bodyAttributes;
 
{$ifDef CPUx86_64}
 
{$ifDef CPUx86_64}
Line 134: Line 129:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Originally Pascal expected ''exact one'' [[Becomes|assignment]] to the result variable (whichever is used).
+
Первоначально Паскаль ожидал ''ровно одно'' [[Becomes|присваивание]] переменной результата (в зависимости от того, что используется). Однако [[FPC]] не запрещает множественные присваивания. Он выдаст предупреждение, если не был использован ни один из возможных идентификаторов результата или процедура выхода не написана.
[[FPC]] however does not prohibit multiple assignments.
 
It will emit a warning if none of the possible result identifiers were used or the exit routine is not written.
 
  
 
<blockquote>
 
<blockquote>
; Warning: Function result does not seem to be set
+
; Warning: Function result does not seem to be set (''рус''. Предупреждение: результат функции, похоже, не установлен)
: You can get this warning if the [[Compiler|compiler]] thinks that a function return value is not set. This will not be  displayed for assembler procedures, or procedures that contain assembler blocks.
+
: You can get this warning if the [[Compiler|compiler]] thinks that a function return value is not set. This will not be  displayed for assembler procedures, or procedures that contain assembler blocks.(''рус''. Вы можете получить это предупреждение, если [[Compiler|компилятор]]  считает, что возвращаемое значение функции не установлено. Это не будет отображаться для ассемблерных процедур или процедур, содержащих ассемблерные блоки.)
 
</blockquote>
 
</blockquote>
  
Line 149: Line 142:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Note, in the case of [[Operator overloading|operator overloads]], a special form of a function, a result variable identifier has to be declared in the formal signature.
+
Обратите внимание, что в случае [[Operator overloading|перегрузок операторов]] в формальной подписи должен быть объявлен специальный вид функции, идентификатор переменной результата. Подробнее см. в статье.
See the article for details.
 
  
 
== Remarks ==
 
== Remarks ==

Revision as of 23:23, 31 May 2022

Deutsch (de) English (en) español (es) suomi (fi) français (fr) русский (ru)

Функция — это подпрограмма, которая, в отличие от процедур, возвращает значение. Вызов функции практически заменяется возвращаемым значением. Если состояние переключателя компилятора {$extendedSyntax} отключено, вызовы функций не могут отображаться как непродуктивные операторы, но должны быть целиком или частью выражения.

Слово function является зарезервированным словом.

Возвращаемое значение

В дополнение к обычной процедуре формальная сигнатура функции содержит тип возвращаемого значения: список формальных параметров должен сопровождаться двоеточием и типом возвращаемого значения. Например, следующая функция возвращает Boolean

function myFunction(const firstParameter: real): Boolean;

При реализации функций есть несколько способов определить возвращаемое значение функции.

 1program functionDemo(input, output, stderr);
 2
 3{$mode objFPC}
 4
 5// традиционный синтаксис:
 6// результат сохраняется в переменной
 7// его имя такое же, как у функции
 8function myLine(const x: real): real;
 9begin
10	myLine := 0.5 * x + 2;
11end;

Если {$modeswitch result+}, заданный {$mode objFPC} и {$mode Delphi}, внутри блока реализации также доступен результат специального идентификатора:

13// используя специальный идентификатор `result`
14function myParabola(const x: real): real;
15begin
16	result := sqr(x) - 1;
17end;

Кроме того, в {$mode objFPC} подпрограмма exit также установит возвращаемое значение и покинет стековый кадр. В предыдущих двух примерах могли появиться дополнительные операторы, и они были бы выполнены, уже после того, как exit подпрограмма выполнится. Это поведение оператора return в C или других языках программирования.

19// использование процедуры выхода exit
20function even(const x: longint): Boolean;
21begin
22  exit(not odd(x));
23end;

В языке ассемблера применяются другие правила. Если тип возвращаемого значения является целым числом, используется регистр-накопитель, при условии, что он помещается туда:

25// на ассемблере:
26// возвращаемый тип умещается в один регистр => использовать регистр-накопитель
27function zero(const x: int64): Boolean;
28{$ifDef CPUx86_64}
29assembler; register;
30{$asmMode intel}
31asm
32	// xor изменяет флаги => поместите его перед тестом
33	xor rax, rax     // rax := 0    (удалить остаток)
34	
35	test x, x        // x = 0 ?
36	setz al          // rax := ZF
37	
38        // Когда вы изучаете вывод ассемблера
39        // вы заметите, что компилятор автоматически вставляет код
40        // который перемещает содержимое rax в нужное место в стеке,
41        // пока не появится подсказка noStackFrame
42        // (автоматически устанавливается некоторыми уровнями оптимизации)
43        // инструктирует компилятор опустить кадр стека, если это возможно.
44end;
45{$else}
46begin
47	result := x = 0;
48end;
49{$endIf}

В противном случае, в зависимости от того, какой режим {$asmMode} активен, можно использовать макрос @result (Intel) или __result (AT&T).

51type
52	bodyAttributes = record
53		surfaceArea: real;
54		volume: real;
55	end;
56
57// на ассемблере:
58// возвращаемый тип не помещается в аккумулятор => макрос @result дает адрес
59function sphere(const radius: real): bodyAttributes;
60{$ifDef CPUx86_64}
61assembler;
62{$asmMode intel}
63const
64	three: longint = 3;
65	four: longint = 4;
66var
67	r: real;
68asm
69	pextrq r, radius, 0 // r := (@radius+0)^
70	lea rax, @result    // rax := @result
71	fld r               // radius
72	
73	fld st(0)           // radius radius
74	fild four           // 4 radius radius
75	fldpi               // pi 4 radius radius
76	fmul                // 4*pi radius radius
77	fxch                // radius 4*pi radius
78	fld st(0)           // radius radius 4*pi radius
79	fmul                // radius^2 4*pi radius
80	fmul                // 4*pi*radius^2 radius
81	fst [rax].bodyAttributes.surfaceArea
82	
83	fmul                // 4*pi*radius^3
84	fild three          // 3 4*pi*radius^3
85	fdivp               // 4/3*pi*radius^3
86	fst [rax].bodyAttributes.volume
87end;
88{$else}
89begin
90	sphere.surfaceArea := 4 * pi() * sqr(radius);
91	sphere.volume := 4 / 3 * pi() * sqr(radius) * abs(radius);
92end;
93{$endIf}

Первоначально Паскаль ожидал ровно одно присваивание переменной результата (в зависимости от того, что используется). Однако FPC не запрещает множественные присваивания. Он выдаст предупреждение, если не был использован ни один из возможных идентификаторов результата или процедура выхода не написана.

Warning
Function result does not seem to be set (рус. Предупреждение: результат функции, похоже, не установлен)
You can get this warning if the compiler thinks that a function return value is not set. This will not be displayed for assembler procedures, or procedures that contain assembler blocks.(рус. Вы можете получить это предупреждение, если компилятор считает, что возвращаемое значение функции не установлено. Это не будет отображаться для ассемблерных процедур или процедур, содержащих ассемблерные блоки.)
95begin
96	writeLn(sphere(2.0).surfaceArea);
97end.

Обратите внимание, что в случае перегрузок операторов в формальной подписи должен быть объявлен специальный вид функции, идентификатор переменной результата. Подробнее см. в статье.

Remarks

Pure functions are functions that do not depend on an external state.

See also