/
ClassDefinition.php
1844 lines (1592 loc) · 57.7 KB
/
ClassDefinition.php
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
<?php
/**
* This file is part of the Zephir.
*
* (c) Zephir Team <team@zephir-lang.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Zephir;
use Zephir\Documentation\Docblock;
use Zephir\Documentation\DocblockParser;
use Zephir\Compiler\CompilerException;
/**
* Zephir\ClassDefinition
*
* Represents a class/interface and their properties and methods.
*
* @package Zephir
*/
class ClassDefinition
{
/** @var string */
protected $namespace;
/** @var string */
protected $name;
/** @var string */
protected $shortName;
/** @var string */
protected $type = 'class';
/** @var string */
protected $extendsClass;
/** @var array */
protected $interfaces;
/** @var bool */
protected $final;
/** @var bool */
protected $abstract;
/** @var bool */
protected $external = false;
/** @var ClassDefinition */
protected $extendsClassDefinition;
/** @var ClassDefinition[] */
protected $implementedInterfaceDefinitions;
/** @var ClassProperty[] */
protected $properties = [];
/** @var ClassConstant[] */
protected $constants = [];
/** @var ClassMethod[] */
protected $methods = [];
/** @var string */
protected $docBlock;
/** @var Docblock */
protected $parsedDocblock;
/** @var int */
protected $dependencyRank = 0;
/** @var array */
protected $originalNode;
/** @var EventsManager */
protected $eventsManager;
/** @var bool */
protected $isBundled = false;
/** @var AliasManager */
protected $_aliasManager = null;
/**
* Whether the constructor was generated by zephir
* (-> no constructor existed previously)
* @var bool
*/
protected $isGeneratedConstructor = false;
/** @var Compiler */
protected $compiler;
/**
* ClassDefinition
*
* @param string $namespace
* @param string $name
* @param string|null $shortName
*/
public function __construct($namespace, $name, $shortName = null)
{
$this->namespace = $namespace;
$this->name = $name;
$this->shortName = $shortName ?: $name;
$this->eventsManager = new EventsManager();
}
/**
* Sets if the class is internal or not
*
* @param boolean $isBundled
*/
public function setIsBundled($isBundled)
{
$this->isBundled = $isBundled;
}
/**
* Returns whether the class is bundled or not
*
* @return bool
*/
public function isBundled()
{
return $this->isBundled;
}
/**
* Sets if the class constructor was generated by zephir
*
* @param boolean $isGeneratedConstructor
*/
public function setIsGeneratedConstructor($isGeneratedConstructor)
{
$this->isGeneratedConstructor = $isGeneratedConstructor;
}
/**
* Returns whether the constructor was generated by zephir
*
* @return bool
*/
public function isGeneratedConstructor()
{
return $this->isGeneratedConstructor;
}
/**
* Sets whether the class is external or not
*
* @param boolean $isExternal
*/
public function setIsExternal($isExternal)
{
$this->external = $isExternal;
}
/**
* Returns whether the class is internal or not
*
* @return bool
*/
public function isExternal()
{
return $this->external;
}
/**
* Get eventsManager for class definition
*
* @return EventsManager
*/
public function getEventsManager()
{
return $this->eventsManager;
}
/**
* Set the class' type (class/interface)
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* Returns the class type
*
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* Returns the class name
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Returns the class name without namespace
*
* @return string
*/
public function getShortName()
{
return $this->shortName;
}
/**
* Check if the class definition correspond to an interface
*
* @return boolean
*/
public function isInterface()
{
return $this->type == 'interface';
}
/**
* Sets if the class is final
*
* @param boolean $final
*/
public function setIsFinal($final)
{
$this->final = (bool) $final;
}
/**
* Sets if the class is final
*
* @param boolean $abstract
*/
public function setIsAbstract($abstract)
{
$this->abstract = (bool) $abstract;
}
/**
* Checks whether the class is abstract or not
*
* @return boolean
*/
public function isAbstract()
{
return $this->abstract;
}
/**
* Checks whether the class is abstract or not
*
* @return boolean
*/
public function isFinal()
{
return $this->final;
}
/**
* Returns the class name including its namespace
*
* @return string
*/
public function getCompleteName()
{
return $this->namespace . '\\' . $this->shortName;
}
/**
* Return the class namespace
*
* @return string
*/
public function getNamespace()
{
return $this->namespace;
}
/**
* Set the original node where the class was declared
*
* @param array $originalNode
*/
public function setOriginalNode(array $originalNode)
{
$this->originalNode = $originalNode;
}
/**
* Sets the extended class
*
* @param string $extendsClass
*/
public function setExtendsClass($extendsClass)
{
$this->extendsClass = $extendsClass;
}
/**
* Sets the implemented interfaces
*
* @param array $implementedInterfaces
*/
public function setImplementsInterfaces(array $implementedInterfaces)
{
$interfaces = array();
foreach ($implementedInterfaces as $implementedInterface) {
$interfaces[] = $implementedInterface['value'];
}
$this->interfaces = $interfaces;
}
/**
* Returns the extended class
*
* @return string
*/
public function getExtendsClass()
{
return $this->extendsClass;
}
/**
* Returns the implemented interfaces
*
* @return array
*/
public function getImplementedInterfaces()
{
return $this->interfaces;
}
/**
* Sets the class definition for the extended class
*
* @param $classDefinition
*/
public function setExtendsClassDefinition($classDefinition)
{
$this->extendsClassDefinition = $classDefinition;
}
/**
* Returns the class definition related to the extended class
*
* @return ClassDefinition
*/
public function getExtendsClassDefinition()
{
if (!$this->extendsClassDefinition && $this->extendsClass) {
if ($this->compiler) {
$this->setExtendsClassDefinition($this->compiler->getClassDefinition($this->extendsClass));
}
}
return $this->extendsClassDefinition;
}
/**
* Sets the class definition for the implemented interfaces
*
* @param ClassDefinition[] $implementedInterfaceDefinitions
*/
public function setImplementedInterfaceDefinitions(array $implementedInterfaceDefinitions)
{
$this->implementedInterfaceDefinitions = $implementedInterfaceDefinitions;
}
/**
* Returns the class definition for the implemented interfaces
*
* @return ClassDefinition[]
*/
public function getImplementedInterfaceDefinitions()
{
return $this->implementedInterfaceDefinitions;
}
/**
* Calculate the dependency rank of the class based on its dependencies
*
*/
public function getDependencies()
{
$dependencies = array();
if ($this->extendsClassDefinition) {
$classDefinition = $this->extendsClassDefinition;
if (method_exists($classDefinition, 'increaseDependencyRank')) {
$dependencies[] = $classDefinition;
}
}
if ($this->implementedInterfaceDefinitions) {
foreach ($this->implementedInterfaceDefinitions as $interfaceDefinition) {
if (method_exists($interfaceDefinition, 'increaseDependencyRank')) {
$dependencies[] = $interfaceDefinition;
}
}
}
return $dependencies;
}
/**
* A class definition calls this method to mark this class as a dependency of another
*
* @param int $rank
*/
public function increaseDependencyRank($rank)
{
$this->dependencyRank += ($rank + 1);
}
/**
* Returns the dependency rank for this class
*
* @return int
*/
public function getDependencyRank()
{
return $this->dependencyRank;
}
/**
* Sets the class/interface docBlock
*
* @param string $docBlock
*/
public function setDocBlock($docBlock)
{
$this->docBlock = $docBlock;
}
/**
* Returns the class/interface docBlock
*
* @return string
*/
public function getDocBlock()
{
return $this->docBlock;
}
/**
* Returns the parsed docBlock
*
* @return DocBlock|null
*/
public function getParsedDocBlock()
{
if (!$this->parsedDocblock) {
if (strlen($this->docBlock) > 0) {
$parser = new DocblockParser("/" . $this->docBlock . "/");
$this->parsedDocblock = $parser->parse();
} else {
return null;
}
}
return $this->parsedDocblock;
}
/**
* Adds a property to the definition
*
* @param ClassProperty $property
* @throws CompilerException
*/
public function addProperty(ClassProperty $property)
{
if (isset($this->properties[$property->getName()])) {
throw new CompilerException("Property '" . $property->getName() . "' was defined more than one time", $property->getOriginal());
}
$this->properties[$property->getName()] = $property;
}
/**
* Adds a constant to the definition
*
* @param ClassConstant $constant
* @throws CompilerException
*/
public function addConstant(ClassConstant $constant)
{
if (isset($this->constants[$constant->getName()])) {
throw new CompilerException("Constant '" . $constant->getName() . "' was defined more than one time");
}
$this->constants[$constant->getName()] = $constant;
}
/**
* Checks if a class definition has a property
*
* @param string $name
* @return boolean
*/
public function hasProperty($name)
{
if (isset($this->properties[$name])) {
return true;
} else {
$extendsClassDefinition = $this->getExtendsClassDefinition();
if ($extendsClassDefinition) {
if ($extendsClassDefinition->hasProperty($name)) {
return true;
}
}
return false;
}
}
/**
* Returns a method definition by its name
*
* @param string string
* @return boolean|ClassProperty
*/
public function getProperty($propertyName)
{
if (isset($this->properties[$propertyName])) {
return $this->properties[$propertyName];
}
$extendsClassDefinition = $this->getExtendsClassDefinition();
if ($extendsClassDefinition) {
if ($extendsClassDefinition->hasProperty($propertyName)) {
return $extendsClassDefinition->getProperty($propertyName);
}
}
return false;
}
/**
* Checks if class definition has a property
*
* @param string $name
* @return bool
*/
public function hasConstant($name)
{
if (isset($this->constants[$name])) {
return true;
}
$extendsClassDefinition = $this->getExtendsClassDefinition();
if ($extendsClassDefinition) {
if ($extendsClassDefinition->hasConstant($name)) {
return true;
}
}
/**
* Check if constant is defined in interfaces
*/
return $this->hasConstantFromInterfaces($name);
}
/**
* Returns a constant definition by its name
*
* @param string $constantName
* @return bool|ClassConstant
*/
public function getConstant($constantName)
{
if (!is_string($constantName)) {
throw new \InvalidArgumentException('$constantName must be string type');
}
if (empty($constantName)) {
throw new \InvalidArgumentException('$constantName must not be empty: ' . $constantName);
}
if (isset($this->constants[$constantName])) {
return $this->constants[$constantName];
}
$extendsClassDefinition = $this->getExtendsClassDefinition();
if ($extendsClassDefinition) {
if ($extendsClassDefinition->hasConstant($constantName)) {
return $extendsClassDefinition->getConstant($constantName);
}
}
/**
* Gets constant from interfaces
*/
return $this->getConstantFromInterfaces($constantName);
}
/**
* Adds a method to the class definition
*
* @param ClassMethod $method
* @param array $statement
*
* @return void
* @throws CompilerException
*/
public function addMethod(ClassMethod $method, $statement = null)
{
$methodName = strtolower($method->getName());
if (isset($this->methods[$methodName])) {
throw new CompilerException("Method '" . $method->getName() . "' was defined more than one time", $statement);
}
$this->methods[$methodName] = $method;
}
/**
* Updates an existing method definition
*
* @param ClassMethod $method
* @param array $statement
*
* @return void
* @throws CompilerException
*/
public function updateMethod(ClassMethod $method, $statement = null)
{
$methodName = strtolower($method->getName());
if (!isset($this->methods[$methodName])) {
throw new CompilerException("Method '" . $method->getName() . "' does not exist", $statement);
}
$this->methods[$methodName] = $method;
}
/**
* Returns all properties defined in the class
*
* @return ClassProperty[]
*/
public function getProperties()
{
return $this->properties;
}
/**
* Returns all constants defined in the class
*
* @return ClassConstant[]
*/
public function getConstants()
{
return $this->constants;
}
/**
* Returns all methods defined in the class
* @return ClassMethod[]
*/
public function getMethods()
{
return $this->methods;
}
/**
* Checks if the class implements an specific name
*
* @param string string
* @return boolean
*/
public function hasMethod($methodName)
{
$methodNameLower = strtolower($methodName);
foreach ($this->methods as $name => $method) {
if ($methodNameLower == $name) {
return true;
}
}
$extendsClassDefinition = $this->getExtendsClassDefinition();
if ($extendsClassDefinition instanceof ClassDefinition) {
if ($extendsClassDefinition->hasMethod($methodName)) {
return true;
}
}
return false;
}
/**
* Returns a method by its name
*
* @param string string
* @param bool|true $checkExtends
*
* @return boolean|ClassMethod
*/
public function getMethod($methodName, $checkExtends = true)
{
$methodNameLower = strtolower($methodName);
foreach ($this->methods as $name => $method) {
if ($methodNameLower == $name) {
return $method;
}
}
if (!$checkExtends) {
return false;
}
$extendsClassDefinition = $this->getExtendsClassDefinition();
if ($extendsClassDefinition instanceof ClassDefinition) {
if ($extendsClassDefinition->hasMethod($methodName)) {
return $extendsClassDefinition->getMethod($methodName);
}
}
return false;
}
/**
* Set a method and its body
*
* @param $methodName
* @param ClassMethod $method
*/
public function setMethod($methodName, ClassMethod $method)
{
$this->methods[$methodName] = $method;
}
/**
* Sets class methods externally
*
* @param array $methods
*/
public function setMethods($methods)
{
$this->methods = $methods;
}
/**
* Tries to find the most similar name
*
* @param string $methodName
* @return string|boolean
*/
public function getPossibleMethodName($methodName)
{
$methodNameLower = strtolower($methodName);
foreach ($this->methods as $name => $method) {
if (metaphone($methodNameLower) == metaphone($name)) {
return $method->getName();
}
}
$extendsClassDefinition = $this->extendsClassDefinition;
if ($extendsClassDefinition) {
return $extendsClassDefinition->getPossibleMethodName($methodName);
}
return false;
}
/**
* Returns the name of the zend_class_entry according to the class name
*
* @param CompilationContext $compilationContext
*
* @return string
* @throws Exception
*/
public function getClassEntry(CompilationContext $compilationContext = null)
{
if ($this->external) {
if (!is_object($compilationContext)) {
throw new Exception('A compilation context is required');
}
$this->compiler = $compilationContext->compiler;
/**
* Automatically add the external header
*/
$compilationContext->headersManager->add($this->getExternalHeader(), HeadersManager::POSITION_LAST);
}
return strtolower(str_replace('\\', '_', $this->namespace) . '_' . $this->name) . '_ce';
}
/**
* Returns a valid namespace to be used in C-sources
*
* @return string
*/
public function getCNamespace()
{
return str_replace('\\', '_', $this->namespace);
}
/**
* Returns a valid namespace to be used in C-sources
*
* @return string
*/
public function getNCNamespace()
{
return str_replace('\\', '\\\\', $this->namespace);
}
/**
* Class name without namespace prefix for class registration
*
* @param string $namespace
* @return string
*/
public function getSCName($namespace)
{
return str_replace($namespace . "_", "", strtolower(str_replace('\\', '_', $this->namespace) . '_' . $this->name));
}
/**
* Returns an absolute location to the class header
*
* @return string
*/
public function getExternalHeader()
{
$parts = explode('\\', $this->namespace);
return 'ext/' . strtolower($parts[0] . DIRECTORY_SEPARATOR . str_replace('\\', DIRECTORY_SEPARATOR, $this->namespace) . DIRECTORY_SEPARATOR . $this->name) . '.zep';
}
/**
* Checks if a class implements an interface
*
* @param ClassDefinition $classDefinition
* @param ClassDefinition $interfaceDefinition
* @throws CompilerException
*/
public function checkInterfaceImplements(ClassDefinition $classDefinition, ClassDefinition $interfaceDefinition)
{
foreach ($interfaceDefinition->getMethods() as $method) {
if (!$classDefinition->hasMethod($method->getName())) {
throw new CompilerException("Class " . $classDefinition->getCompleteName() . " must implement a method called: \"" . $method->getName() . "\" as requirement of interface: \"" . $interfaceDefinition->getCompleteName() . "\"");
}
if ($method->hasParameters()) {
$implementedMethod = $classDefinition->getMethod($method->getName());
if ($implementedMethod->getNumberOfRequiredParameters() > $method->getNumberOfRequiredParameters() || $implementedMethod->getNumberOfParameters() < $method->getNumberOfParameters()) {
throw new CompilerException("Class " . $classDefinition->getCompleteName() . "::" . $method->getName() . "() does not have the same number of required parameters in interface: \"" . $interfaceDefinition->getCompleteName() . "\"");
}
}
}
}
/**
* Pre-compiles a class/interface gathering method information required by other methods
*
* @param CompilationContext $compilationContext
* @throws CompilerException
*/
public function preCompile(CompilationContext $compilationContext)
{
$this->compiler = $compilationContext->compiler;
/**
* Pre-Compile methods
*/
foreach ($this->methods as $method) {
if ($this->getType() == 'class' && !$method->isAbstract()) {
$method->preCompile($compilationContext);
}
}
}
/**
* Returns the initialization method if any does exist
*
* @return ClassMethod
*/
public function getInitMethod()
{
$initClassName = $this->getCNamespace() . '_' . $this->getName();
return $this->getMethod('zephir_init_properties_' . $initClassName);
}
/**
* Returns the initialization method if any does exist
*
* @return ClassMethod
*/
public function getStaticInitMethod()
{
$initClassName = $this->getCNamespace() . '_' . $this->getName();
return $this->getMethod('zephir_init_static_properties_' . $initClassName);
}
/**
* Returns the initialization method if any does exist
*
* @return ClassMethod
*/
public function getLocalOrParentInitMethod()
{
$method = $this->getInitMethod();
if ($method) {
$parentClassDefinition = $this->getExtendsClassDefinition();
if ($parentClassDefinition instanceof ClassDefinition) {
$method = $parentClassDefinition->getInitMethod();
if ($method) {
$this->addInitMethod($method->getStatementsBlock());
}
}
}
return $method;
}
/**
* Creates the initialization method
*
* @param StatementsBlock $statementsBlock
*/
public function addInitMethod(StatementsBlock $statementsBlock)
{
if (!$statementsBlock->isEmpty()) {
$initClassName = $this->getCNamespace() . '_' . $this->getName();
$classMethod = new ClassMethod(
$this,
['internal'],
'zephir_init_properties_' . $initClassName,
null,
$statementsBlock
);
$classMethod->setIsInitializer(true);
$this->addMethod($classMethod);
}
}
/**
* Creates the static initialization method
*
* @param StatementsBlock $statementsBlock
*/
public function addStaticInitMethod(StatementsBlock $statementsBlock)
{
$initClassName = $this->getCNamespace() . '_' . $this->getName();
$classMethod = new ClassMethod(
$this,
array('internal'),
'zephir_init_static_properties_' . $initClassName,
null,
$statementsBlock
);
$classMethod->setIsInitializer(true);
$classMethod->setIsStatic(true);
$this->addMethod($classMethod);
}
/**
* Compiles a class/interface
*
* @param CompilationContext $compilationContext
*
* @throws CompilerException
* @throws Exception
*/
public function compile(CompilationContext $compilationContext)
{
$this->compiler = $compilationContext->compiler;
/**
* Sets the current object as global class definition
*/
$compilationContext->classDefinition = $this;
/**
* Get the global codePrinter
*/
$codePrinter = $compilationContext->codePrinter;
/**
* The ZEPHIR_INIT_CLASS defines properties and constants exported by the class
*/