Skip to content

Commit c05285e

Browse files
zobozobo
authored
Add InlineValue objects to generated LSP (#19)
* Add protocol.inlineValue.d.ts, handle literal types. * Add Inline objects. * Improved class generation.
1 parent 065fc70 commit c05285e

15 files changed

+664
-14
lines changed

‎src/InlayHintOptions.php‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,31 @@
77
use RuntimeException;
88

99
/**
10-
* Mixins (implemented TS interfaces): WorkDoneProgressOptions, array
10+
* Mixins (implemented TS interfaces): WorkDoneProgressOptions
1111
*/
1212
class InlayHintOptions
1313
{
14+
/**
15+
* The server provides support to resolve additional
16+
* information for an inlay hint item.
17+
*
18+
* @var bool|null
19+
*/
20+
public $resolveProvider;
21+
1422
/**
1523
*
1624
* @var bool|null
1725
*/
1826
public $workDoneProgress;
1927

2028
/**
29+
* @param bool|null $resolveProvider
2130
* @param bool|null $workDoneProgress
2231
*/
23-
public function __construct(?bool $workDoneProgress = null)
32+
public function __construct(?bool $resolveProvider = null, ?bool $workDoneProgress = null)
2433
{
34+
$this->resolveProvider = $resolveProvider;
2535
$this->workDoneProgress = $workDoneProgress;
2636
}
2737

@@ -32,6 +42,7 @@ public function __construct(?bool $workDoneProgress = null)
3242
public static function fromArray(array $array, bool $allowUnknownKeys = false)
3343
{
3444
$map = [
45+
'resolveProvider' => ['names' => [], 'iterable' => false],
3546
'workDoneProgress' => ['names' => [], 'iterable' => false],
3647
];
3748

‎src/InlayHintParams.php‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,24 @@
77
use RuntimeException;
88

99
/**
10-
* Mixins (implemented TS interfaces): WorkDoneProgressParams, array
10+
* Mixins (implemented TS interfaces): WorkDoneProgressParams
1111
*/
1212
class InlayHintParams
1313
{
14+
/**
15+
* The text document.
16+
*
17+
* @var TextDocumentIdentifier
18+
*/
19+
public $textDocument;
20+
21+
/**
22+
* The document range for which inlay hints should be computed.
23+
*
24+
* @var Range
25+
*/
26+
public $range;
27+
1428
/**
1529
* An optional token that a server can use to report work done progress.
1630
*
@@ -19,10 +33,14 @@ class InlayHintParams
1933
public $workDoneToken;
2034

2135
/**
36+
* @param TextDocumentIdentifier $textDocument
37+
* @param Range $range
2238
* @param int|string|null $workDoneToken
2339
*/
24-
public function __construct($workDoneToken = null)
40+
public function __construct(TextDocumentIdentifier $textDocument, Range $range, $workDoneToken = null)
2541
{
42+
$this->textDocument = $textDocument;
43+
$this->range = $range;
2644
$this->workDoneToken = $workDoneToken;
2745
}
2846

@@ -33,6 +51,8 @@ public function __construct($workDoneToken = null)
3351
public static function fromArray(array $array, bool $allowUnknownKeys = false)
3452
{
3553
$map = [
54+
'textDocument' => ['names' => [TextDocumentIdentifier::class], 'iterable' => false],
55+
'range' => ['names' => [Range::class], 'iterable' => false],
3656
'workDoneToken' => ['names' => [], 'iterable' => false],
3757
];
3858

‎src/InlineValueEvaluatableExpression.php‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<?php // Auto-generated from vscode-languageserver-protocol (typescript)
2+
3+
namespace Phpactor\LanguageServerProtocol;
4+
5+
use DTL\Invoke\Invoke;
6+
use Exception;
7+
use RuntimeException;
8+
9+
class InlineValueEvaluatableExpression
10+
{
11+
/**
12+
* The document range for which the inline value applies.
13+
* The range is used to extract the evaluatable expression from the underlying document.
14+
*
15+
* @var Range
16+
*/
17+
public $range;
18+
19+
/**
20+
* If specified the expression overrides the extracted expression.
21+
*
22+
* @var string|null
23+
*/
24+
public $expression;
25+
26+
/**
27+
* @param Range $range
28+
* @param string|null $expression
29+
*/
30+
public function __construct(Range $range, ?string $expression = null)
31+
{
32+
$this->range = $range;
33+
$this->expression = $expression;
34+
}
35+
36+
/**
37+
* @param array<string,mixed> $array
38+
* @return self
39+
*/
40+
public static function fromArray(array $array, bool $allowUnknownKeys = false)
41+
{
42+
$map = [
43+
'range' => ['names' => [Range::class], 'iterable' => false],
44+
'expression' => ['names' => [], 'iterable' => false],
45+
];
46+
47+
foreach ($array as $key => &$value) {
48+
if (!isset($map[$key])) {
49+
if ($allowUnknownKeys) {
50+
unset($array[$key]);
51+
continue;
52+
}
53+
54+
throw new RuntimeException(sprintf(
55+
'Parameter "%s" on class "%s" not known, known parameters: "%s"',
56+
$key,
57+
self::class,
58+
implode('", "', array_keys($map))
59+
));
60+
}
61+
62+
// from here we only care about arrays that can be transformed into
63+
// objects
64+
if (!is_array($value)) {
65+
continue;
66+
}
67+
68+
if (empty($map[$key]['names'])) {
69+
continue;
70+
}
71+
72+
if ($map[$key]['iterable']) {
73+
$value = array_map(function ($object) use ($map, $key, $allowUnknownKeys) {
74+
if (!is_array($object)) {
75+
return $object;
76+
}
77+
78+
return self::invokeFromNames($map[$key]['names'], $object, $allowUnknownKeys) ?: $object;
79+
}, $value);
80+
continue;
81+
}
82+
83+
$names = $map[$key]['names'];
84+
$value = self::invokeFromNames($names, $value, $allowUnknownKeys) ?: $value;
85+
}
86+
87+
return Invoke::new(self::class, $array);
88+
}
89+
90+
/**
91+
* @param array<string> $classNames
92+
* @param array<string,mixed> $object
93+
*/
94+
private static function invokeFromNames(array $classNames, array $object, bool $allowUnknownKeys): ?object
95+
{
96+
$lastException = null;
97+
foreach ($classNames as $className) {
98+
try {
99+
// @phpstan-ignore-next-line
100+
return call_user_func_array($className . '::fromArray', [$object, $allowUnknownKeys]);
101+
} catch (Exception $exception) {
102+
$lastException = $exception;
103+
continue;
104+
}
105+
}
106+
107+
throw $lastException;
108+
}
109+
110+
}

‎src/InlineValueParams.php‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<?php // Auto-generated from vscode-languageserver-protocol (typescript)
2+
3+
namespace Phpactor\LanguageServerProtocol;
4+
5+
use DTL\Invoke\Invoke;
6+
use Exception;
7+
use RuntimeException;
8+
9+
/**
10+
* Mixins (implemented TS interfaces): WorkDoneProgressParams
11+
*/
12+
class InlineValueParams
13+
{
14+
/**
15+
* The text document.
16+
*
17+
* @var TextDocumentIdentifier
18+
*/
19+
public $textDocument;
20+
21+
/**
22+
* The document range for which inline values should be computed.
23+
*
24+
* @var Range
25+
*/
26+
public $range;
27+
28+
/**
29+
* Additional information about the context in which inline values were
30+
* requested.
31+
*
32+
* @var array{frameId:int,stoppedLocation:Range}
33+
*/
34+
public $context;
35+
36+
/**
37+
* An optional token that a server can use to report work done progress.
38+
*
39+
* @var int|string|null
40+
*/
41+
public $workDoneToken;
42+
43+
/**
44+
* @param TextDocumentIdentifier $textDocument
45+
* @param Range $range
46+
* @param array{frameId:int,stoppedLocation:Range} $context
47+
* @param int|string|null $workDoneToken
48+
*/
49+
public function __construct(TextDocumentIdentifier $textDocument, Range $range, array $context, $workDoneToken = null)
50+
{
51+
$this->textDocument = $textDocument;
52+
$this->range = $range;
53+
$this->context = $context;
54+
$this->workDoneToken = $workDoneToken;
55+
}
56+
57+
/**
58+
* @param array<string,mixed> $array
59+
* @return self
60+
*/
61+
public static function fromArray(array $array, bool $allowUnknownKeys = false)
62+
{
63+
$map = [
64+
'textDocument' => ['names' => [TextDocumentIdentifier::class], 'iterable' => false],
65+
'range' => ['names' => [Range::class], 'iterable' => false],
66+
'context' => ['names' => [], 'iterable' => false],
67+
'workDoneToken' => ['names' => [], 'iterable' => false],
68+
];
69+
70+
foreach ($array as $key => &$value) {
71+
if (!isset($map[$key])) {
72+
if ($allowUnknownKeys) {
73+
unset($array[$key]);
74+
continue;
75+
}
76+
77+
throw new RuntimeException(sprintf(
78+
'Parameter "%s" on class "%s" not known, known parameters: "%s"',
79+
$key,
80+
self::class,
81+
implode('", "', array_keys($map))
82+
));
83+
}
84+
85+
// from here we only care about arrays that can be transformed into
86+
// objects
87+
if (!is_array($value)) {
88+
continue;
89+
}
90+
91+
if (empty($map[$key]['names'])) {
92+
continue;
93+
}
94+
95+
if ($map[$key]['iterable']) {
96+
$value = array_map(function ($object) use ($map, $key, $allowUnknownKeys) {
97+
if (!is_array($object)) {
98+
return $object;
99+
}
100+
101+
return self::invokeFromNames($map[$key]['names'], $object, $allowUnknownKeys) ?: $object;
102+
}, $value);
103+
continue;
104+
}
105+
106+
$names = $map[$key]['names'];
107+
$value = self::invokeFromNames($names, $value, $allowUnknownKeys) ?: $value;
108+
}
109+
110+
return Invoke::new(self::class, $array);
111+
}
112+
113+
/**
114+
* @param array<string> $classNames
115+
* @param array<string,mixed> $object
116+
*/
117+
private static function invokeFromNames(array $classNames, array $object, bool $allowUnknownKeys): ?object
118+
{
119+
$lastException = null;
120+
foreach ($classNames as $className) {
121+
try {
122+
// @phpstan-ignore-next-line
123+
return call_user_func_array($className . '::fromArray', [$object, $allowUnknownKeys]);
124+
} catch (Exception $exception) {
125+
$lastException = $exception;
126+
continue;
127+
}
128+
}
129+
130+
throw $lastException;
131+
}
132+
133+
}

‎src/InlineValueRefreshRequest.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php // Auto-generated from vscode-languageserver-protocol (typescript)
2+
3+
namespace Phpactor\LanguageServerProtocol;
4+
5+
interface InlineValueRefreshRequest
6+
{
7+
public const METHOD = 'workspace/inlineValue/refresh';
8+
}

0 commit comments

Comments
 (0)