MPGA.pm

filter: Statementstmt 100% 73 / 73 Branchbran 93.4% 43 / 46 Conditioncond 100% 7 / 7 MC/DCmcdc 100% 4 / 4 Subroutinesub 100% 9 / 9 Podpod 20.0% 1 / 5 totaltotal 95.1% 137 / 144 CC 27 SCAR 21.0
CC
27
Cov
98%
step
14.0
flow
7.0
flow_ctx
4.0
CRAP 8.2
↑ Summary MPGA/Trace.pm »
1 package MPGA;
2  
3 7 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 7 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 7 ▶use Attribute::Handlers; # Добавлено для поддержки атрибутов
Subroutine BEGIN: called CC=1 SCAR=0.0
6  
7 7 require Exporter;
8  
9 7 our @ISA = qw(Exporter);
10  
11 # Items to export into callers namespace by default. Note: do not export
12 # names by default without a very good reason. Use EXPORT_OK instead.
13 # Do not simply export all your public functions/methods/constants.
14  
15 # This allows declaration use MPGA ':all';
16 # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
17 # will save memory.
18 7 our %EXPORT_TAGS = ( 'all' => [ qw(
19
20 ) ] );
21  
22 7 our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
23  
24 7 our @EXPORT = qw(
25 flow flow_ctx step chunk
26 );
27  
28 7 our $VERSION = '0.24';
29 # данная версия модуля MPGA кардинально отличается от предыдущей 0.08 версии следующим:
30 # - изменена логика разбора потока - теперь только прямой порядок следования аргументов,
31 # без всяких reverse и pop;
32 # - специальный объект для хранения контекста потока;
33 # - у функций появился атрибут количества обязательных аргументов.
34 # однако, модуль спроектирован так, что в нем сохраняется обратная совместимость, и код
35 # написанный в старом стиле все равно будет работать.
36  
37  
38 # Реестр для хранения количества обязательных аргументов функций
39 7 our %REGISTRY;
40  
41  
42 # Определение атрибута :MPGAargsNum
43 # этот атрибут необходим функциям, чтобы указать MPGA сколько аргументов обязательно
44 # нужно исполняемой функции, это для удобства работы в новом стиле. основываясь на
45 # это атрибуте step() предоставит функции именно такой длины массив аргументов @$args.
46 # исполняемая функция должна иметь примерно такой вид:
47 # sub fun : MPGAargsNum(3) {
48 # my ($self, $args, $flow, $ctx) = @_;
49 # my $args1 = shift @$args;
50 # my $args2 = shift @$args;
51 # my $args3 = shift @$args;
52 #
53 # .....
54 # return;
55 # }
56 # данная запись явно дает понять, что это не обычная функция perl, а функция, которая
57 # написана для исполнения модулем MPGA и ей необходимы 3 обязательных аргумента.
58 # если же этот атрибут не указан
59 # sub old_style_fun {
60 # my ($self, $args, $flow) = @_;
61 # my $args1 = pop @$args;
62 # .....
63 # return;
64 # }
65 # значит функция написана в старом стиле и она сама управляет @$args и контекстом.
66 15 ▶sub UNIVERSAL::MPGAargsNum : ATTR(CODE) {
Subroutine MPGAargsNum: called CC=2 SCAR=7.2
Pod undocumented
67 15 my ($package, $symbol, $referent, $attr, $argsNum) = @_;
68  
69 # Если данные пришли в виде массива, берем первый элемент.
70 # Если как обычный скаляр — берем его как есть.
71 15 ▶ $REGISTRY{$referent} = ref($argsNum) eq 'ARRAY' ? $argsNum->[0] : $argsNum;
Branch: 1 branch
BranchTrueFalseTotal
ref $argsNum eq 'ARRAY' ? : 15 0 15
72 7 ▶}
Subroutine BEGIN: called CC=1 SCAR=0.0
73  
74  
75 # функция flow_ctx() принимает ссылку на массив, и в этом массиве первый
76 # элемент считается объектом контекста ctx, который будет передан
77 # во все функции потока. вы можете определять ctx как угодно.
78 # рекомендую пустой хэш {}, в котором можно будет хранить промежуточные
79 # состояния функций (естественно надо не забывать их чистить :))
80 11 ▶sub flow_ctx {
Subroutine flow_ctx: called CC=4 SCAR=13.9
Pod undocumented
81 11 my $flow = shift;
82  
83 11 ▶ return if !$flow;
Branch: 1 branch
BranchTrueFalseTotal
unless $flow 2 9 11
84 9 ▶ return if ref( $flow ) ne 'ARRAY';
Branch: 1 branch
BranchTrueFalseTotal
if ref $flow ne "ARRAY" 1 8 9
85 8 ▶ return if !scalar @$flow;
Branch: 1 branch
BranchTrueFalseTotal
unless scalar @$flow 1 7 8
86  
87 # Откусываем первый элемент и сохраняем его как контекст выполнения
88 7 my $ctx = shift @$flow;
89  
90 # Передаем чистый поток и контекст дальше в цепочку
91 7 flow( $flow, $ctx );
92  
93 7 return;
94 }
95  
96  
97 # функция flow() принимает три аргумента:
98 # первый аргумент обязательный - ссылка на массив - поток,
99 # второй аргумент необязательный $ctx - контекст,
100 # третий аргумент необязательный $max_steps - лимит шагов (0 = без ограничения).
101 # поток разбирается слева направо функцией step() пока не опустошится или не достигнут лимит $max_steps.
102 27 ▶sub flow {
Subroutine flow: called CC=7 SCAR=19.5
Pod documented
103 27 my $flow = shift;
104 27 my $ctx = shift; # Принимаем контекст (будет undef, если вызван обычный flow)
105 27 ▶ my $max_steps = shift || 0;
Condition100%2/2
shift() || 0
l!l
621
MC/DC100%1/1
shift() || 0
shift()
Truth table100%2/2
A
A= shift()
Aresult
11
00
106  
107 27 ▶ return if !$flow;
Branch: 1 branch
BranchTrueFalseTotal
unless $flow 2 25 27
108 25 ▶ return if ref( $flow ) ne 'ARRAY';
Branch: 1 branch
BranchTrueFalseTotal
if ref $flow ne "ARRAY" 5 20 25
109  
110 20 ▶ while(scalar @$flow) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @$flow) 33 17 50
111 33 step( $flow, $ctx ); # Передаем $ctx в step() на каждом шаге
112 33 ▶ last if $max_steps && --$max_steps <= 0;
Branch: 1 branch
BranchTrueFalseTotal
if $max_steps and --$max_steps <= 0 3 30 33
Condition100%3/3
$max_steps and --$max_steps <= 0
!ll&&!rl&&r
2463
MC/DC100%2/2
$max_steps and --$max_steps <= 0
$max_steps --$max_steps <= 0
Truth table100%3/3
A and B
A= $max_stepsB= --$max_steps <= 0
ABresult
0X0
100
111
113 }
114  
115 20 return;
116 }
117  
118  
119 # функция step() принимает два аргумента:
120 # первый аргумент обязательный - ссылка на массив - поток,
121 # второй аргумент необязательный $ctx - контекст.
122 # поток парсится слева направо с помощью вызова функции chunk()
123 # в поисках первой ссылки на функцию.
124 # эта функция заносится в переменную $fun и будет исполняться, а все переменные
125 # найденные до этой функции заносятся в массив накопленных аргументов @$args.
126 # таким образом $flow становится короче.
127 #
128 # step() принимает поток в прямом порядке
129 #
130 # исполняемой функции $fun передаются четыре аргумента:
131 # sub fun {
132 # my ( $self, $args, $flow, $ctx ) = @_;
133 # .....
134 # return;
135 # }
136 # - $fun - сама эта функция
137 # - вторым аргументом идет ссылка на массив аргументов (или undef, если перед
138 # функцией в потоке не было ни одного аргумента):
139 # * если у функции задан атрибут :MPGAargsNum(N) — это ссылка на массив из N
140 # ближайших к функции аргументов, которые забрали с конца массива
141 # накопленных аргументов
142 # * если атрибут не задан — это ссылка на весь массив накопленных аргументов
143 # - $flow - остаток потока
144 # - $ctx - общий объект контекста (может быть undef)
145 #
146 # функция $fun может модифицировать любые свои аргументы
147 # - первый аргумент - ссылка на саму себя, модифицировать ее в принципе можно, но не нужно,
148 # функция передается сама себе для того, чтобы в случае необходимости она могла
149 # рекурсивно возвратить саму себя в поток @$flow
150 # - второй аргумент - массив аргументов @$args - аргументы могут относиться к этой функции или
151 # к другой, которая идет дальше по потоку, это зависит от того определен ли у функции
152 # атрибут MPGAargsNum:
153 # - если определен, то в @$args именно MPGAargsNum аргументов, и их можно обрабатывать самым
154 # обычным способом через shift.
155 # - если не определен, то в @$args возможно не все аргументы относятся к этой функции
156 # и обрабатывать их надо осторожно, чтобы не удалить из потока транзитные аргументы.
157 # поэтому надо обрабатывать их через pop и получать в обратном порядке с конца.
158 # - третий аргумент - поток $flow - тоже может быть модифицирован с целью изменить поток
159 # выполнения программы, но так как считается, что рядовая функция не должна знать слишком много,
160 # то рекомендую модифицировать поток только в плане прекращения потока в случае ошибки,
161 # это достигается обнулением @$flow и возвратом undef, т.е. надо выполнить такой код:
162 # @$flow = ();
163 # return;
164 # - четвертый аргумент - контекст ctx. если поток был определен через функцию flow_ctx, то
165 # это первый элемент этого потока - контекст, который должен быть передан всем функциям этого потока.
166 #
167 # исполняемая функция $fun может вернуть
168 # - ссылку на массив - в этом случае элементы массива вставляются в начало
169 # остатка потока $flow (через unshift, распаковывая массив)
170 # - ссылка на хэш - в этом случае возврат трактуется как объект, который
171 # вставляется в начало остатка потока $flow (через unshift)
172 # - скаляр - в этом случае возврат трактуется как скаляр, который
173 # вставляется в начало остатка потока $flow (через unshift)
174 # - undef - в этом случае поток $flow не меняется
175 # - во всех других случаях $flow не меняется
176 #
177 # после выполнения функции $fun список аргументов @$args может быть не пустым
178 # (транзитные аргументы), в таком случае они вставляются в начало потока @$flow
179 # ПЕРЕД результатом работы $fun. итоговый порядок в потоке:
180 # [...транзитные args..., ...результат $fun..., ...остаток потока...]
181 # также надо взять за правило, что функция $fun всегда должна заканчиваться return,
182 # иначе будет возвращен результат последнего оператора функции.
183 # таким образом функция всегда должна заканчиваться как-то так:
184 # return [...]; - ссылка на массив
185 # return {...}; - ссылка на хэш
186 # return $scalar; - скаляр
187 # return; - undef
188 63 ▶sub step {
Subroutine step: called CC=14 SCAR=26.4
Pod undocumented
189 63 my $flow = shift;
190 63 my $ctx = shift; # Принимаем контекст
191  
192 63 ▶ return if !$flow;
Branch: 1 branch
BranchTrueFalseTotal
unless $flow 2 61 63
193 61 ▶ return if ref($flow) ne 'ARRAY';
Branch: 1 branch
BranchTrueFalseTotal
if ref $flow ne "ARRAY" 5 56 61
194  
195 56 ▶ if(scalar @$flow) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @$flow) 56 0 56
196 56 my ($fun, $args) = chunk($flow);
197  
198 56 ▶ if ($fun) {
Branch: 1 branch
BranchTrueFalseTotal
if ($fun) 50 6 56
199 50 my $res;
200  
201 # Если у функции объявлен атрибут :MPGAargsNum
202 50 ▶ if ( exists $REGISTRY{$fun} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $MPGA::REGISTRY{$fun}) { } 27 23 50
203 27 my $argsNum = $REGISTRY{$fun};
204  
205 27 ▶ my $actual_args = defined $args ? scalar @$args : 0;
Branch: 1 branch
BranchTrueFalseTotal
defined $args ? : 20 7 27
206 27 ▶ if ($actual_args < $argsNum) {
Branch: 1 branch
BranchTrueFalseTotal
if ($actual_args < $argsNum) 2 25 27
207 2 print "Предупреждение: !!!!! аргументов ($actual_args) меньше чем требуется ($argsNum)\n";
208 2 $argsNum = $actual_args;
209 }
210  
211 # ПРАВИЛЬНЫЙ ВАРИАНТ:
212 # Если требуется 0 аргументов — создаем пустой массив,
213 # иначе безопасно забираем $argsNum элементов с конца.
214 27 ▶ my @pass_args = ($argsNum == 0) ? () : splice(@$args, -$argsNum);
Branch: 1 branch
BranchTrueFalseTotal
$argsNum == 0 ? : 8 19 27
215  
216 # Передаю стандартный набор аргументов
217 27 $res = $fun->($fun, \@pass_args, $flow, $ctx);
218  
219 # Всё, что было в @pass_args, здесь забывается, так как переменная выходит из области видимости
220 }
221 else {
222 # Старый режим совместимости: передаем исходный $args целиком и $ctx четвертым аргументом
223 23 $res = $fun->($fun, $args, $flow, $ctx);
224 }
225  
226 50 ▶ if( defined $res ) { # $fun вернула что-то определённое, НЕ undef
Branch: 1 branch
BranchTrueFalseTotal
if (defined $res) 18 32 50
227 18 ▶ if( ref( $res ) eq 'ARRAY' ) { # $fun вернула ссылку на массив
Branch: 1 branch
BranchTrueFalseTotal
if (ref $res eq 'ARRAY') { } 11 7 18
228 11 ▶ unshift(@$flow, @$res) if scalar @$res;
Branch: 1 branch
BranchTrueFalseTotal
if scalar @$res 11 0 11
229 }
230 else {
231 7 unshift @$flow, $res;
232 }
233 }
234  
235 # Если в $args еще остались транзитные аргументы — возвращаем их в начало потока
236 50 ▶ if (defined $args && scalar @$args) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $args and scalar @$args) 19 31 50
Condition100%2/2
defined $args and scalar @$args
!ll
1436
MC/DC100%1/1
defined $args and scalar @$args
defined $args
Truth table100%2/2
A
A= defined $args
Aresult
00
11
237 19 unshift @$flow, @$args;
238 }
239 }
240 }
241  
242 56 return;
243 }
244  
245  
246 # функция chunk() принимает только ссылку на массив,
247 # в котором ищет первую с начала ссылку на функцию, всё, что не является ссылкой на функцию
248 # считается аргументом функции и попадает в массив аргментов.
249 # возвращает массив из двух элементов ( fun, [args] )
250 #
251 70 ▶sub chunk {
Subroutine chunk: called CC=4 SCAR=13.9
Pod undocumented
252 70 my $flow = shift;
253  
254 70 ▶ return if ref( $flow ) ne 'ARRAY';
Branch: 1 branch
BranchTrueFalseTotal
if ref $flow ne "ARRAY" 6 64 70
255  
256 64 my ($fun, $args);
257  
258 64 ▶ while(scalar @$flow) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @$flow) 155 9 164
259 155 my $item = shift @$flow;
260 155 ▶ if( ref $item ne 'CODE' ) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $item ne 'CODE') { } 100 55 155
261 100 push @$args, $item; # Аргументы собираются слева направо в прямом порядке
262 }
263 else {
264 55 $fun = $item;
265 55 last;
266 }
267 }
268  
269 64 return $fun, $args;
270 }
271  
272  
273 # Preloaded methods go here.
274  
275 7 1;
276 __END__
↑ Summary MPGA/Trace.pm »