ClearScript/ClearScript/ScriptEngine.cs at master · slamj1/ClearScript · GitHub

History

2142 lines (1914 loc) · 95.8 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

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

// Licensed under the MIT license.

using System;

using System.Collections;

using System.Collections.Generic;

using System.Linq;

using System.Reflection;

using System.Runtime.CompilerServices;

using Microsoft.ClearScript.Util;

namespace Microsoft.ClearScript

{

/// <summary>

/// Provides the base implementation for all script engines.

/// </summary>

public abstract class ScriptEngine : IDisposable

{

#region data

private Type accessContext;

private ScriptAccess defaultAccess;

private bool enforceAnonymousTypeAccess;

private bool exposeHostObjectStaticMembers;

private DocumentSettings documentSettings;

private readonly DocumentSettings defaultDocumentSettings = new DocumentSettings();

private static readonly IUniqueNameManager nameManager = new UniqueNameManager();

private static readonly object nullHostObjectProxy = new object();

[ThreadStatic] private static ScriptEngine currentEngine;

#endregion

#region constructors

/// <summary>

/// Initializes a new script engine instance.

/// </summary>

/// <param name="name">A name to associate with the instance. Currently this name is used only as a label in presentation contexts such as debugger user interfaces.</param>

[Obsolete("Use ScriptEngine(string name, string fileNameExtensions) instead.")]

protected ScriptEngine(string name)

: this(name, null)

{

}

/// <summary>

/// Initializes a new script engine instance with the specified list of supported file name extensions.

/// </summary>

/// <param name="name">A name to associate with the instance. Currently this name is used only as a label in presentation contexts such as debugger user interfaces.</param>

/// <param name="fileNameExtensions">A semicolon-delimited list of supported file name extensions.</param>

protected ScriptEngine(string name, string fileNameExtensions)

{

Name = nameManager.GetUniqueName(name, GetType().GetRootName());

defaultDocumentSettings.FileNameExtensions = fileNameExtensions;

extensionMethodTable = realExtensionMethodTable = new ExtensionMethodTable();

}

#endregion

#region public members

/// <summary>

/// Gets the name associated with the script engine instance.

/// </summary>

public string Name { get; }

/// <summary>

/// Gets the script engine that is invoking a host member on the current thread.

/// </summary>

/// <remarks>

/// If multiple script engines are invoking host members on the current thread, this

/// property gets the one responsible for the most deeply nested invocation. If no script

/// engines are invoking host members on the current thread, this property returns

/// <c>null</c>.

/// </remarks>

public static ScriptEngine Current => currentEngine;

/// <summary>

/// Gets the script engine's recommended file name extension for script files.

/// </summary>

public abstract string FileNameExtension { get; }

/// <summary>

/// Allows script code to access non-public host resources.

/// </summary>

/// <remarks>

/// By setting this property to a type you declare that script code running in the current

/// script engine is to be treated as if it were part of that type's implementation. Doing

/// so does not expose any host resources to script code, but it affects which host

/// resources are importable and which members of exposed resources are accessible.

/// </remarks>

public Type AccessContext

{

get => accessContext;

set

{

accessContext = value;

OnAccessSettingsChanged();

}

/// <summary>

/// Gets or sets the default script access setting for all members of exposed objects.

/// </summary>

/// <remarks>

/// Use <c><see cref="DefaultScriptUsageAttribute"/></c>, <c><see cref="ScriptUsageAttribute"/></c>, or

/// their subclasses to override this property for individual types and members. Note that

/// this property has no effect on the method binding algorithm. If a script-based call is

/// bound to a method that is blocked by this property, it will be rejected even if an

/// overload exists that could receive the call.

/// </remarks>

public ScriptAccess DefaultAccess

{

get => defaultAccess;

set

{

defaultAccess = value;

OnAccessSettingsChanged();

}

/// <summary>

/// Enables or disables access restrictions for anonymous types.

/// </summary>

/// <remarks>

/// Anonymous types are

/// <c><see href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/internal">internal</see></c>

/// and therefore accessible only within the same assembly, but ClearScript 5.5.3 and

/// earlier permitted access to the public properties of an object even if its type was

/// internal. Newer versions strictly enforce <c><see cref="AccessContext"/></c>, but because

/// anonymous types are particularly useful for scripting, ClearScript by default continues

/// to expose their properties to external contexts. To override this behavior and enable

/// normal access restrictions for anonymous types, set this property to <c>true</c>.

/// </remarks>

public bool EnforceAnonymousTypeAccess

{

get => enforceAnonymousTypeAccess;

set

{

enforceAnonymousTypeAccess = value;

OnAccessSettingsChanged();

}

/// <summary>

/// Controls whether host objects provide access to the static members of their exposed types to script code.

/// </summary>

public bool ExposeHostObjectStaticMembers

{

get => exposeHostObjectStaticMembers;

set

{

exposeHostObjectStaticMembers = value;

OnAccessSettingsChanged();

}

/// <summary>

/// Enables or disables extension method support.

/// </summary>

public bool DisableExtensionMethods

{

get => extensionMethodTable == emptyExtensionMethodTable;

set

{

var newExtensionMethodTable = value ? emptyExtensionMethodTable : realExtensionMethodTable;

if (newExtensionMethodTable != extensionMethodTable)

{

ScriptInvoke(() =>

{

if (newExtensionMethodTable != extensionMethodTable)

{

extensionMethodTable = newExtensionMethodTable;

bindCache.Clear();

OnAccessSettingsChanged();

}

});

}

/// <summary>

/// Enables or disables script code formatting.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, the script engine may format script code

/// before executing or compiling it. This is intended to facilitate interactive debugging.

/// The formatting operation currently includes stripping leading and trailing blank lines

/// and removing global indentation.

/// </remarks>

public bool FormatCode { get; set; }

/// <summary>

/// Controls whether script code is permitted to use reflection.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, script code running in the current script

/// engine is permitted to use reflection. This affects

/// <c><see cref="object.GetType">Object.GetType()</see></c>,

/// <c><see cref="Exception.GetType">Exception.GetType()</see></c>,

/// <c><see cref="Exception.TargetSite">Exception.TargetSite</see></c>,

/// <c><see cref="Delegate.Method">Delegate.Method</see></c>,

/// <c><see cref="HostFunctions.typeOf(object)"/></c> and <c><see cref="HostFunctions.typeOf{T}"/></c>.

/// By default, any attempt to invoke these members from script code results in an

/// exception.

/// </remarks>

public bool AllowReflection { get; set; }

/// <summary>

/// Enables or disables type restriction for field, property, and method return values.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, script code running in the current script

/// engine has access to the runtime types of all exposed host resources, which by default

/// are restricted to their declared types. The default behavior is a general requirement

/// for correct method binding, so setting this property to <c>true</c> is not recommended.

/// </remarks>

/// <c><seealso cref="ScriptMemberFlags.ExposeRuntimeType"/></c>

public bool DisableTypeRestriction { get; set; }

/// <summary>

/// Enables or disables type restriction for array and list elements retrieved by index.

/// </summary>

/// <remarks>

/// In ClearScript 5.4.4 and earlier, indexed array and list elements were exempt from type

/// restriction. ClearScript 5.4.5 introduced a breaking change to correct this, but you can

/// set this property to <c>true</c> to restore the exemption if you have older script code

/// that depends on it.

/// </remarks>

/// <c><seealso cref="DisableTypeRestriction"/></c>

public bool DisableListIndexTypeRestriction { get; set; }

/// <summary>

/// Enables or disables <c>null</c> wrapping for field, property, and method return values.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, all field, property, and method return values

/// are marshaled with full .NET type information even if they are <c>null</c>. Note that

/// such values will always fail equality comparison with JavaScript's

/// <c><see href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null">null</see></c>,

/// VBScript's

/// <c><see href="https://docs.microsoft.com/en-us/previous-versions//f8tbc79x(v=vs.85)">Nothing</see></c>,

/// and other similar values. Instead, use <c><see cref="HostFunctions.isNull"/></c> or

/// <c><see cref="object.Equals(object, object)"/></c> to perform such a comparison.

/// </remarks>

/// <c><seealso cref="ScriptMemberFlags.WrapNullResult"/></c>

/// <c><seealso cref="HostFunctions.isNull"/></c>

public bool EnableNullResultWrapping { get; set; }

/// <summary>

/// Enables or disables floating point narrowing.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, no attempt is made to convert floating-point

/// values imported from the script engine to the narrowest equivalent .NET representation.

/// The default behavior is more likely to result in successful method binding in specific

/// scenarios, so setting this property to <c>true</c> is not recommended.

/// </remarks>

public bool DisableFloatNarrowing { get; set; }

/// <summary>

/// Enables or disables the use of reflection-based method binding as a fallback.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, the script engine attempts to use

/// reflection-based method binding when the default method binding algorithm fails. This

/// approach reduces type safety, but it may be useful for running legacy scripts that rely

/// on the specific behavior of reflection-based method binding.

/// </remarks>

public bool UseReflectionBindFallback { get; set; }

/// <summary>

/// Enables or disables automatic host variable tunneling for by-reference arguments to script functions and delegates.

/// </summary>

/// <remarks>

/// When this property is set to <c>true</c>, the script engine replaces by-reference

/// arguments to script functions and delegates with host variables, allowing script code

/// to simulate output arguments if the script language does not support them natively.

/// </remarks>

/// <c><seealso cref="HostFunctions.newVar{T}(T)"/></c>

public bool EnableAutoHostVariables { get; set; }

/// <summary>

/// Gets or sets the engine's undefined import value.

/// </summary>

/// <remarks>

/// Some script languages support one or more special non-<c>null</c> values that represent

/// nonexistent, missing, unknown, or undefined data. When such a value is marshaled to the

/// host, the script engine maps it to the value of this property. The default value is

/// <c><see cref="Undefined.Value">Undefined.Value</see></c>.

/// </remarks>

public object UndefinedImportValue { get; set; } = Undefined.Value;

/// <summary>

/// Gets or sets the engine's null export value.

/// </summary>

/// <remarks>

/// <para>

/// When a null object reference is marshaled to script code, the script engine maps it to

/// the value of this property. The default value is simply <c>null</c>, which corresponds

/// to <c>null</c> or its closest equivalent in the script language. Other useful

/// possibilities include

/// <c><see cref="Undefined.Value">Undefined.Value</see></c> and

/// <c><see href="https://microsoft.github.io/ClearScript/Reference/html/F_Microsoft_ClearScript_Windows_Nothing_Value.htm">Nothing.Value</see></c>.

/// </para>

/// <para>

/// Note that <see cref="ScriptMemberFlags.WrapNullResult"/>,

/// <see cref="EnableNullResultWrapping"/>, and

/// <see href="https://microsoft.github.io/ClearScript/Reference/html/T_Microsoft_ClearScript_Windows_WindowsScriptEngineFlags.htm">MarshalNullAsDispatch</see>

/// all take precedence over this property.

/// </para>

/// </remarks>

public object NullExportValue { get; set; }

/// <summary>

/// Gets or sets the engine's void result export value.

/// </summary>

/// <remarks>

/// Some script languages expect every subroutine call to return a value. When script code

/// written in such a language invokes a host method that explicitly returns no value (such

/// as a C#

/// <c><see href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/void">void</see></c>

/// method), the script engine returns the value of this property as a dummy result. The

/// default value is <c><see cref="VoidResult.Value">VoidResult.Value</see></c>.

/// </remarks>

public object VoidResultValue { get; set; } = VoidResult.Value;

/// <summary>

/// Gets or sets a callback that can be used to halt script execution.

/// </summary>

/// <remarks>

/// During script execution the script engine periodically invokes this callback to

/// determine whether it should continue. If the callback returns <c>false</c>, the script

/// engine terminates script execution and throws an exception.

/// </remarks>

public ContinuationCallback ContinuationCallback { get; set; }

/// <summary>

/// Allows the host to access script resources dynamically.

/// </summary>

/// <remarks>

/// The value of this property is an object that is bound to the script engine's root

/// namespace. It dynamically supports properties and methods that correspond to global

/// script objects and functions.

/// </remarks>

public abstract dynamic Script { get; }

/// <summary>

/// Allows the host to access script resources.

/// </summary>

/// <remarks>

/// The value of this property is an object that is bound to the script engine's root

/// namespace. It allows you to access global script resources via the

/// <c><see cref="ScriptObject"/></c> class interface. Doing so is likely to perform better than

/// dynamic access via <c><see cref="Script"/></c>.

/// </remarks>

public abstract ScriptObject Global { get; }

/// <summary>

/// Gets or sets the script engine's document settings.

/// </summary>

public DocumentSettings DocumentSettings

{

get => documentSettings ?? defaultDocumentSettings;

set => documentSettings = value;

}

/// <summary>

/// Exposes a host object to script code.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="target">The object to expose.</param>

/// <remarks>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </remarks>

public void AddHostObject(string itemName, object target)

{

AddHostObject(itemName, HostItemFlags.None, target);

}

/// <summary>

/// Exposes a host object to script code with the specified options.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="target">The object to expose.</param>

/// <remarks>

/// <para>

/// Once a host object is exposed to script code, its members are accessible via the script

/// language's native syntax for member access. The following table provides details about

/// the mapping between host members and script-accessible properties and methods.

/// </para>

/// <para>

/// <list type="table">

/// <listheader>

/// <term>Member Type</term>

/// <term>Exposed As</term>

/// <description>Remarks</description>

/// </listheader>

/// <item>

/// <term>Constructor</term>

/// <term>N/A</term>

/// <description>

/// To invoke a constructor from script code, call

/// <c><see cref="HostFunctions.newObj{T}">HostFunctions.newObj(T)</see></c>.

/// </description>

/// </item>

/// <item>

/// <term>Property/Field</term>

/// <term>Property</term>

/// <description>N/A</description>

/// </item>

/// <item>

/// <term>Method</term>

/// <description>

/// Overloaded host methods are merged into a single script-callable method. At

/// runtime the correct host method is selected based on the argument types.

/// </description>

/// </item>

/// <item>

/// <term>Generic Method</term>

/// <term>Method</term>

/// <description>

/// The ClearScript library supports dynamic C#-like type inference when invoking

/// generic methods. However, some methods require explicit type arguments. To call

/// such a method from script code, you must place the required number of

/// <see cref="AddHostType(string, HostItemFlags, Type)">host type objects</see>

/// at the beginning of the argument list. Doing so for methods that do not require

/// explicit type arguments is optional.

/// </description>

/// </item>

/// <item>

/// <term>Extension Method</term>

/// <term>Method</term>

/// <description>

/// Extension methods are available if the type that implements them has been

/// exposed in the current script engine.

/// </description>

/// </item>

/// <item>

/// <term>Indexer</term>

/// <term>Property</term>

/// <description>

/// Indexers appear as properties named "Item" that accept one or more index values

/// as arguments. In addition, objects that implement <c><see cref="IList"/></c> expose

/// properties with numeric names that match their valid indices. This includes

/// one-dimensional host arrays and other collections. Multidimensional host arrays

/// do not expose functional indexers; you must use

/// <c><see href="https://docs.microsoft.com/en-us/dotnet/api/system.array.getvalue">Array.GetValue</see></c>

/// and

/// <c><see href="https://docs.microsoft.com/en-us/dotnet/api/system.array.setvalue">Array.SetValue</see></c>

/// instead.

/// </description>

/// </item>

/// <item>

/// <term>Event</term>

/// <term>Property</term>

/// <description>

/// Events are exposed as read-only properties of type <c><see cref="EventSource{T}"/></c>.

/// </description>

/// </item>

/// </list>

/// </para>

/// </remarks>

public void AddHostObject(string itemName, HostItemFlags flags, object target)

{

MiscHelpers.VerifyNonNullArgument(target, nameof(target));

AddHostItem(itemName, flags, target);

}

/// <summary>

/// Exposes a host object to script code with the specified type restriction.

/// </summary>

/// <typeparam name="T">The type whose members are to be made accessible from script code.</typeparam>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="target">The object to expose.</param>

/// <remarks>

/// <para>

/// This method can be used to restrict script access to the members of a particular

/// interface or base class.

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddRestrictedHostObject<T>(string itemName, T target)

{

AddRestrictedHostObject(itemName, HostItemFlags.None, target);

}

/// <summary>

/// Exposes a host object to script code with the specified type restriction and options.

/// </summary>

/// <typeparam name="T">The type whose members are to be made accessible from script code.</typeparam>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="target">The object to expose.</param>

/// <remarks>

/// <para>

/// This method can be used to restrict script access to the members of a particular

/// interface or base class.

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddRestrictedHostObject<T>(string itemName, HostItemFlags flags, T target)

{

AddHostItem(itemName, flags, HostItem.Wrap(this, target, typeof(T)));

}

/// <summary>

/// Creates a COM/ActiveX object and exposes it to script code. The registered class is

/// specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to instantiate.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMObject(string itemName, string progID)

{

AddCOMObject(itemName, HostItemFlags.None, progID);

}

/// <summary>

/// Creates a COM/ActiveX object on the specified server and exposes it to script code. The

/// registered class is specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to instantiate.</param>

/// <param name="serverName">The name of the server on which to create the object.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMObject(string itemName, string progID, string serverName)

{

AddCOMObject(itemName, HostItemFlags.None, progID, serverName);

}

/// <summary>

/// Creates a COM/ActiveX object and exposes it to script code with the specified options.

/// The registered class is specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to instantiate.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMObject(string itemName, HostItemFlags flags, string progID)

{

AddCOMObject(itemName, flags, progID, null);

}

/// <summary>

/// Creates a COM/ActiveX object on the specified server and exposes it to script code with

/// the specified options. The registered class is specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to instantiate.</param>

/// <param name="serverName">The name of the server on which to create the object.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMObject(string itemName, HostItemFlags flags, string progID, string serverName)

{

AddHostItem(itemName, flags, MiscHelpers.CreateCOMObject(progID, serverName));

}

/// <summary>

/// Creates a COM/ActiveX object and exposes it to script code. The registered class is

/// specified by class identifier (CLSID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="clsid">The class identifier (CLSID) of the registered class to instantiate.</param>

/// <remarks>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </remarks>

public void AddCOMObject(string itemName, Guid clsid)

{

AddCOMObject(itemName, HostItemFlags.None, clsid);

}

/// <summary>

/// Creates a COM/ActiveX object on the specified server and exposes it to script code. The

/// registered class is specified by class identifier (CLSID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="clsid">The class identifier (CLSID) of the registered class to instantiate.</param>

/// <param name="serverName">The name of the server on which to create the object.</param>

/// <remarks>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </remarks>

public void AddCOMObject(string itemName, Guid clsid, string serverName)

{

AddCOMObject(itemName, HostItemFlags.None, clsid, serverName);

}

/// <summary>

/// Creates a COM/ActiveX object and exposes it to script code with the specified options.

/// The registered class is specified by class identifier (CLSID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="clsid">The class identifier (CLSID) of the registered class to instantiate.</param>

/// <remarks>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </remarks>

public void AddCOMObject(string itemName, HostItemFlags flags, Guid clsid)

{

AddCOMObject(itemName, flags, clsid, null);

}

/// <summary>

/// Creates a COM/ActiveX object on the specified server and exposes it to script code with

/// the specified options. The registered class is specified by class identifier (CLSID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the object.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="clsid">The class identifier (CLSID) of the registered class to instantiate.</param>

/// <param name="serverName">The name of the server on which to create the object.</param>

/// <remarks>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </remarks>

public void AddCOMObject(string itemName, HostItemFlags flags, Guid clsid, string serverName)

{

AddHostItem(itemName, flags, MiscHelpers.CreateCOMObject(clsid, serverName));

}

/// <summary>

/// Exposes a host type to script code with a default name.

/// </summary>

/// <param name="type">The type to expose.</param>

/// <remarks>

/// <para>

/// This method uses <paramref name="type"/>'s name for the new global script item that

/// will represent it.

/// </para>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(Type type)

{

AddHostType(HostItemFlags.None, type);

}

/// <summary>

/// Exposes a host type to script code with a default name and the specified options.

/// </summary>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="type">The type to expose.</param>

/// <remarks>

/// <para>

/// This method uses <paramref name="type"/>'s name for the new global script item that

/// will represent it.

/// </para>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(HostItemFlags flags, Type type)

{

AddHostType(type.GetRootName(), flags, type);

}

/// <summary>

/// Exposes a host type to script code.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="type">The type to expose.</param>

/// <remarks>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(string itemName, Type type)

{

AddHostType(itemName, HostItemFlags.None, type);

}

/// <summary>

/// Exposes a host type to script code with the specified options.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="type">The type to expose.</param>

/// <remarks>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(string itemName, HostItemFlags flags, Type type)

{

MiscHelpers.VerifyNonNullArgument(type, nameof(type));

AddHostItem(itemName, flags, HostType.Wrap(type));

}

/// <summary>

/// Exposes a host type to script code. The type is specified by name.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="typeName">The fully qualified name of the type to expose.</param>

/// <param name="typeArgs">Optional generic type arguments.</param>

/// <remarks>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(string itemName, string typeName, params Type[] typeArgs)

{

AddHostType(itemName, HostItemFlags.None, typeName, typeArgs);

}

/// <summary>

/// Exposes a host type to script code with the specified options. The type is specified by name.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="typeName">The fully qualified name of the type to expose.</param>

/// <param name="typeArgs">Optional generic type arguments.</param>

/// <remarks>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(string itemName, HostItemFlags flags, string typeName, params Type[] typeArgs)

{

AddHostItem(itemName, flags, TypeHelpers.ImportType(typeName, null, false, typeArgs));

}

/// <summary>

/// Exposes a host type to script code. The type is specified by type name and assembly name.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="typeName">The fully qualified name of the type to expose.</param>

/// <param name="assemblyName">The name of the assembly that contains the type to expose.</param>

/// <param name="typeArgs">Optional generic type arguments.</param>

/// <remarks>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(string itemName, string typeName, string assemblyName, params Type[] typeArgs)

{

AddHostType(itemName, HostItemFlags.None, typeName, assemblyName, typeArgs);

}

/// <summary>

/// Exposes a host type to script code with the specified options. The type is specified by

/// type name and assembly name.

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="typeName">The fully qualified name of the type to expose.</param>

/// <param name="assemblyName">The name of the assembly that contains the type to expose.</param>

/// <param name="typeArgs">Optional generic type arguments.</param>

/// <remarks>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostType(string itemName, HostItemFlags flags, string typeName, string assemblyName, params Type[] typeArgs)

{

AddHostItem(itemName, flags, TypeHelpers.ImportType(typeName, assemblyName, true, typeArgs));

}

/// <summary>

/// Exposes host types to script code.

/// </summary>

/// <param name="types">The types to expose.</param>

/// <remarks>

/// <para>

/// This method uses each specified type's name for the new global script item that will

/// represent it.

/// </para>

/// <para>

/// Host types are exposed to script code in the form of objects whose properties and

/// methods are bound to the type's static members and nested types. If the type has

/// generic parameters, the corresponding object will be invocable with type arguments to

/// yield a specific type.

/// </para>

/// <para>

/// For more information about the mapping between host members and script-callable

/// properties and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddHostTypes(params Type[] types)

{

if (types != null)

{

foreach (var type in types)

{

if (type != null)

{

AddHostType(type);

}

/// <summary>

/// Imports a COM/ActiveX type and exposes it to script code. The registered class is

/// specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to import.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMType(string itemName, string progID)

{

AddCOMType(itemName, HostItemFlags.None, progID);

}

/// <summary>

/// Imports a COM/ActiveX type from the specified server and exposes it to script code. The

/// registered class is specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to import.</param>

/// <param name="serverName">The name of the server from which to import the type.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMType(string itemName, string progID, string serverName)

{

AddCOMType(itemName, HostItemFlags.None, progID, serverName);

}

/// <summary>

/// Imports a COM/ActiveX type and exposes it to script code with the specified options.

/// The registered class is specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to import.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMType(string itemName, HostItemFlags flags, string progID)

{

AddCOMType(itemName, flags, progID, null);

}

/// <summary>

/// Imports a COM/ActiveX type from the specified server and exposes it to script code with

/// the specified options. The registered class is specified by programmatic identifier (ProgID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="flags">A value that selects options for the operation.</param>

/// <param name="progID">The programmatic identifier (ProgID) of the registered class to import.</param>

/// <param name="serverName">The name of the server from which to import the type.</param>

/// <remarks>

/// <para>

/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard

/// GUID format with braces (e.g., "{0D43FE01-F093-11CF-8940-00A0C9054228}").

/// </para>

/// <para>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </para>

/// </remarks>

public void AddCOMType(string itemName, HostItemFlags flags, string progID, string serverName)

{

AddHostItem(itemName, flags, HostType.Wrap(MiscHelpers.GetCOMType(progID, serverName)));

}

/// <summary>

/// Imports a COM/ActiveX type and exposes it to script code. The registered class is

/// specified by class identifier (CLSID).

/// </summary>

/// <param name="itemName">A name for the new global script item that will represent the type.</param>

/// <param name="clsid">The class identifier (CLSID) of the registered class to import.</param>

/// <remarks>

/// For information about the mapping between host members and script-callable properties

/// and methods, see <c><see cref="AddHostObject(string, HostItemFlags, object)"/></c>.

/// </remarks>

public void AddCOMType(string itemName, Guid clsid)

View remainder of file in raw view

ClearScript/ClearScript/ScriptEngine.cs at master · slamj1/ClearScript · GitHub

Expand file tree

Breadcrumbs

ScriptEngine.cs

Latest commit

History

Breadcrumbs

ScriptEngine.cs

File metadata and controls