hack-codegen/src/CodegenClassish.hack at main · onkeypress-llc/hack-codegen · GitHub

History

438 lines (387 loc) · 11.4 KB

Raw

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

* This source code is licensed under the MIT license found in the

* LICENSE file in the root directory of this source tree.

namespace Facebook\HackCodegen;

use namespace HH\Lib\{C, Str, Vec};

use namespace Facebook\HackCodegen\_Private\{C as CP, Vec as VecP};

/**

* Abstract class to generate class-like definitions.

* @see CodegenClass

* @see CodegenInterface

* @see CodegenTrait

* @see CodegenEnum

abstract class CodegenClassish implements ICodeBuilderRenderer {

use CodegenWithVisibility;

use CodegenWithAttributes;

use HackBuilderRenderer;

protected vec<string> $genericsDecl = vec[];

protected ?string $docBlock;

protected ?CodegenGeneratedFrom $generatedFrom;

protected ?CodegenFunction $wrapperFunc = null;

protected vec<CodegenMethod> $methods = vec[];

private vec<CodegenUsesTrait> $traits = vec[];

protected vec<CodegenConstantish> $consts = vec[];

protected vec<CodegenXHPAttribute> $xhpAttributes = vec[];

protected vec<CodegenProperty> $vars = vec[];

private bool $isConsistentConstruct = false;

protected bool $hasManualFooter = false;

protected bool $hasManualHeader = false;

private ?string $headerName;

private ?string $headerContents;

private ?string $footerName;

private ?string $footerContents;

public function __construct(

protected IHackCodegenConfig $config,

protected string $name,

) {

}

/** @selfdocumenting */

public function getName(): string {

return $this->name;

}

/**

* Add generic parameters.

* For example:

* ```

* $class->addGenerics(vec['TRead', 'TWrite as T']);

* ```

* Will generate:

* ```

* class MyClass<TRead, TWrite as T> {

* ```

* @see addGeneric

* @see addGenericf

public function addGenerics(

Traversable<string> $generics_decl,

): this {

foreach ($generics_decl as $decl) {

$this->addGeneric($decl);

}

return $this;

}

/** Add a generic parameter using a %-placeholder format string.

* @see addGenerics

public function addGenericf(

Str\SprintfFormatString $format,

mixed ...$args

): this {

$this->addGenerics(\vsprintf($format, $args));

return $this;

}

/** Add a generic parameter.

* @see addGenerics

* @see addGenericsf

public function addGeneric(

string $decl,

): this {

$this->genericsDecl[] = $decl;

return $this;

}

/** Add a generic parameter with subtype constraint.

* Subtype constraint of two types ```T``` and ```U``` will be evaluated to

* the following: ```T as U``` whereas this statement asserts

* that ```T``` must be a subtype of ```U```.

* @see addGeneric

* @see addGenericSupertypeConstraint

public function addGenericSubtypeConstraint(

string $subtype,

string $baseType

): this {

$this->addGeneric($subtype.' as '.$baseType);

return $this;

}

/** Add a generic parameter with supertype constraint.

* Supertype constraint of two types ```T``` and ```U``` will be evaluated to

* the following: ```T super U``` whereas this statement asserts

* that ```T``` must be a supertype of ```U```.

* @see addGeneric

* @see addGenericSubtypeConstraint

public function addGenericSupertypeConstraint(

string $superType,

string $subtype

): this {

$this->addGeneric($superType.' super '.$subtype);

return $this;

}

/** @selfdocumenting */

public function addMethods(Traversable<CodegenMethod> $methods): this {

foreach ($methods as $method) {

$this->addMethod($method);

}

return $this;

}

/** @selfdocumenting */

public function addMethod(CodegenMethod $method): this {

$method->setContainingClass($this);

$this->methods[] = $method;

return $this;

}

/** @selfdocumenting */

public function addXhpAttribute(CodegenXHPAttribute $attribute): this {

$this->xhpAttributes[] = $attribute;

return $this;

}

/** @selfdocumenting */

public function addXhpAttributes(Traversable<CodegenXHPAttribute> $attributes): this {

foreach($attributes as $attr) {

$this->addXhpAttribute($attr);

}

return $this;

}

/** @selfdocumenting */

public function setDocBlock(string $comment): this {

$this->docBlock = $comment;

return $this;

}

/** @selfdocumenting */

public function setGeneratedFrom(CodegenGeneratedFrom $from): this {

$this->generatedFrom = $from;

return $this;

}

/** @selfdocumenting */

protected function getTraits(): vec<string> {

// Trait<T> becomes Trait

return Vec\map(

$this->traits,

$trait ==> {

$name = $trait->getName();

return \strstr($name, '<', true) ?: $name;

);

}

/** @selfdocumenting */

public function addTraits(Traversable<CodegenUsesTrait> $traits): this {

foreach ($traits as $trait) {

$this->addTrait($trait);

}

return $this;

}

/** @selfdocumenting */

public function addTrait(CodegenUsesTrait $trait): this {

$this->traits[] = $trait;

return $this;

}

/** @selfdocumenting */

public function addConstant(

CodegenClassConstant $const,

): this {

$this->consts[] = $const;

return $this;

}

public function addTypeConstant(CodegenTypeConstant $const): this {

$this->consts[] = $const;

return $this;

}

/** @selfdocumenting */

public function addProperty(CodegenProperty $var): this {

$this->vars[] = $var;

return $this;

}

/** @selfdocumenting */

public function addProperties(Traversable<CodegenProperty> $vars): this {

$this->vars = Vec\concat(

$this->vars,

vec($vars),

);

return $this;

}

/**

* Set whether or not the class has a section to contain manually written

* or modified methods.

* Manual method sections appear at the bottom of the class.

* You may specify a name for the section, which will appear in

* the comment and is used to merge the code when re-generating it.

* You may also specify a default content for the manual section, e.g.

* a comment indicating that additional methods should be placed there.

public function setHasManualMethodSection(

bool $value = true,

?string $name = null,

?string $contents = null,

): this {

$this->hasManualFooter = $value;

$this->footerName = $name;

$this->footerContents = $contents;

return $this;

}

/**

* If value is set to true, the class will have a section for manually adding

* declarations, such as type constants.

* Manual declaration sections appear at the top of the class.

* You may specify a name for the section, which will appear in

* the comment and is used to merge the code when re-generating it.

* You may also specify a default content for the manual section, e.g.

* a comment indicating that additional declarations should be placed there.

public function setHasManualDeclarations(

bool $value = true,

?string $name = null,

?string $contents = null,

): this {

$this->hasManualHeader = $value;

$this->headerName = $name;

$this->headerContents = $contents;

return $this;

}

/** Requires subclasses to have compatible constructors. */

public function setIsConsistentConstruct(bool $value = true): this {

$this->isConsistentConstruct = $value;

return $this;

}

abstract protected function buildDeclaration(HackBuilder $builder): void;

protected function buildGenericsDeclaration(): string {

$generics_count = C\count($this->genericsDecl);

if ($generics_count === 0) {

return '';

}

if ($generics_count === 1) {

return '<'.C\onlyx($this->genericsDecl).'>';

}

return $this->genericsDecl

|> Vec\map(

$$,

$decl ==> ' '.$decl.",\n",

)

|> Str\join($$, '')

|> Str\strip_suffix($$, ",\n")

|> "\n <\n".$$."\n >";

}

protected function buildTraits(HackBuilder $builder): void {

if (C\is_empty($this->traits)) {

return;

}

$builder->ensureEmptyLine();

foreach ($this->traits as $trait) {

$builder->add($trait->render());

}

protected function buildConsts(HackBuilder $builder): void {

if (C\is_empty($this->consts)) {

return;

}

$builder->ensureEmptyLine();

foreach ($this->consts as $const) {

if ($const->getDocBlock() is nonnull) {

$builder->ensureEmptyLine();

}

$const->appendToBuilder($builder);

}

protected function buildXHPAttributes(HackBuilder $builder): void {

if (C\is_empty($this->xhpAttributes)) {

return;

}

$builder->ensureNewLine();

$builder->addLine('attribute')->indent();

$attributes = $this->xhpAttributes;

$last = VecP\pop_backx(inout $attributes);

foreach($attributes as $attr) {

$builder->addRenderer($attr);

$builder->addLine(',');

}

$builder->addRenderer($last)->addLine(';')->unindent();

}

protected function buildVars(HackBuilder $builder): void {

if (C\is_empty($this->vars)) {

return;

}

$builder->ensureEmptyLine();

foreach ($this->vars as $var) {

$builder->addRenderer($var);

}

protected function buildMethods(HackBuilder $builder): void {

foreach ($this->methods as $method) {

$builder->ensureEmptyLine()->addRenderer($method);

}

if ($this->hasManualFooter) {

$footer_name = $this->footerName === null

? ($this->name.'_footer')

: $this->footerName;

$footer = $this->footerContents === null

? '// Insert additional methods here'

: $this->footerContents;

$builder

->ensureEmptyLine()

->startManualSection($footer_name)

->addLine($footer)

->endManualSection();

}

protected function buildManualDeclarations(HackBuilder $builder): void {

if ($this->hasManualHeader) {

$manual_section = CP\coalescevax($this->headerName, $this->name.'_header');

$content = CP\coalescevax(

$this->headerContents,

'// Insert additional consts and vars here',

);

$builder

->ensureEmptyLine()

->startManualSection($manual_section)

->addLine($content)

->endManualSection();

}

/** Returns all the attributes defined on the class */

protected function getExtraAttributes(): dict<string, vec<string>> {

if ($this->isConsistentConstruct) {

return dict['__ConsistentConstruct' => vec[]];

}

return dict[];

}

/** Append just the body of the class (between `{` and `}` to a

* `HackBuilder` */

abstract protected function appendBodyToBuilder(HackBuilder $builder): void;

/** Append the entire declaration to a `HackBuilder`.

* This includes the keywords, interface declaraitons, etc - and the

* body.

final public function appendToBuilder(HackBuilder $builder): HackBuilder {

$generated_from =

$this->generatedFrom ? $this->generatedFrom->render() : null;

$doc_block_parts = Vec\filter_nulls(vec[$this->docBlock, $generated_from]);

if ($doc_block_parts) {

$builder->addDocBlock(Str\join($doc_block_parts, "\n\n"));

}

$wrapper_func = $this->wrapperFunc;

if ($wrapper_func) {

$builder->addRenderer($wrapper_func)->ensureEmptyLine();

}

if ($this->hasAttributes()) {

$builder->ensureNewLine()->addLine($this->renderAttributes());

}

$this->buildDeclaration($builder);

$builder->openBrace();

$this->appendBodyToBuilder($builder);

$builder->closeBrace();

return $builder;

}

hack-codegen/src/CodegenClassish.hack at main · onkeypress-llc/hack-codegen · GitHub

Expand file tree

Breadcrumbs

CodegenClassish.hack

Latest commit

History

Breadcrumbs

CodegenClassish.hack

File metadata and controls