AutoLISP Cookbook 14: Self-Contained Single-File AutoLISP Plugins with On-the-Fly Temporary DCL Dialogs
Eliminate missing `.dcl` file deployment errors by dynamically writing Dialog Control Language definitions to `vl-filename-mktemp`, invoking `load_dialog`, and cleaning up automatically.
1. Single-File Self-Contained AutoLISP Deployment: Generating Temporary `.dcl` Dialog Definitions on the Fly
Distributing an AutoLISP utility across 300 engineering workstations usually fails when users copy the `.lsp` file but forget to place the companion `.dcl` (Dialog Control Language) UI file into GstarCAD's Support File Search Path—triggering `load_dialog failed` errors. Writing the DCL interface definition to `(vl-filename-mktemp "ui.dcl")` at runtime makes your `.lsp` or compiled `.zelx`/`.fas` plugin 100% self-contained in a single file.
Critical Kernel & Memory Safety Rule: Always follow the strict DCL lifecycle state machine: write the temporary `.dcl` file → call `(load_dialog tmpFile)` → initialize layout via `(new_dialog "dlgName" dclId)` → populate list boxes with `(start_list)`/`(add_list)`/`(end_list)` → bind `(action_tile)` callbacks → block on `(start_dialog)` → call `(unload_dialog dclId)` → and finally delete the temp file via `(vl-file-delete tmpFile)` so temporary directories remain clean.
2. Production Visual LISP / AutoLISP Routine (vl-filename-mktemp)
Load the following self-contained LISP routine via APPLOAD or gcaddoc.lsp in GstarCAD 2027 to automate AutoLISP Cookbook 14: Self-Contained Single-File AutoLISP Plugins with On-the-Fly Temporary DCL Dialogs at native database speed:
;; GstarCAD 2027 AutoLISP — Zero-Dependency Dynamic DCL Dialog Pattern
(defun c:GcQuickDialog ( / dclFile fn dclId userInput)
(setq dclFile (vl-filename-mktemp "gcad_ui.dcl")
fn (open dclFile "w"))
(write-line "gc_dlg : dialog { label = \"GstarCAD Project Setup\"; : edit_box { key = \"proj\"; label = \"Project ID:\"; } ok_only; }" fn)
(close fn)
(setq dclId (load_dialog dclFile))
(if (new_dialog "gc_dlg" dclId)
(progn
(action_tile "accept" "(setq userInput (get_tile \"proj\")) (done_dialog 1)")
(start_dialog)
(unload_dialog dclId)
)
)
(vl-file-delete dclFile)
(princ (strcat "\nConfigured Project ID: " (if userInput userInput "None")))
(princ)
)
3. ObjectARX-to-GRX & .NET API Porting Matrix
When dual-targeting plugins for both AutoCAD and GstarCAD 2027 from a unified Git repository, reference the following symbol, header, and assembly mapping table:
| SDK Dimension | AutoCAD® ObjectARX / .NET | GstarCAD 2027 GRX / .NET Equivalent |
|---|---|---|
| Target API Classes | vl-filename-mktemp, load_dialog, new_dialog, action_tile, start_dialog, vl-file-delete |
Identical class & method signatures via compat headers |
| C++ Binary Extension | *.arx / *.dbx |
*.grx / *.tx (Loaded via APPLOAD or Registry) |
| Managed .NET Assemblies | acmgd.dll, acdbmgd.dll, accoremgd.dll |
GsMgd.dll, GsDbMgd.dll (Set Copy Local = False) |
4. Memory Management, Thread Safety & QA Checklist
- Deterministic Object Closure & Transaction Disposal: In C++ GRX, every
acdbOpenObject()call that returnsAcad::eOkmust be paired with an explicitpObj->close()before starting a command or returning control to the editor. In C# .NET, always wrapStartTransaction()inside ausingblock and explicitly calltr.Commit(). - Document Locking from Modeless Contexts: Whenever modifying the active DWG database from a modeless WPF
PaletteSet, WinForms dialog, or external COM event, acquire a write lock viadoc.LockDocument()to preventeLockViolationexceptions. - Multi-Core Fiber & Main-Thread Discipline: The DWG database (`AcDbDatabase`) is not thread-safe for concurrent writes. Offload heavy geometric calculations or SQL/REST I/O to background worker threads, then marshal database mutations back to the main CAD UI thread.
Production Compilation, Packaging & Enterprise Deployment Guide
When deploying this developer recipe into commercial enterprise production, development leads should configure automated CI/CD build agents (GitHub Actions or Azure DevOps) using MSBuild command-line flags. Ensure that all dependent assemblies (such as GsMgd.dll and GsDbMgd.dll) have their reference property set to Copy Local = False (Private=False) to prevent deployment conflicts with the host GstarCAD 2027 application folder:
- Target Framework Alignment: For C# .NET plugins, target .NET Framework 4.8 or .NET 8.0 Windows Desktop runtime depending on your GstarCAD host version. For C++ GRX extensions, compile using Visual Studio 2022 (MSVC v143) with the platform toolset set to 64-bit (x64) and Character Set set to Unicode.
- Registry-Free Autoloading (.bundle): Package your compiled binary and menu CUIX files into an Autodesk/GstarCAD-compatible Application Package bundle folder (e.g.,
EnterprisePlugin.bundle/PackageContents.xml) and deploy directly to%APPDATA%\Autodesk\ApplicationPluginsor%PROGRAMDATA%\Gstarsoft\ApplicationPluginsfor automatic silent loading without requiring administrative Windows registry rights. - Automated Exception Trapping & Telemetry: Always wrap top-level command methods and event handlers inside structured
try-catchor AutoLISPvl-catch-all-applyblocks to log diagnostic stack traces to corporate log repositories rather than letting unhandled exceptions crash the host drawing session.
| Build Artifact | Production Location | Deployment Verification Gate |
|---|---|---|
| C++ GRX Binary | bin/x64/Release/*.grx |
Verify zero unresolved DLL imports via Dependency Walker / dumpbin /dependents. |
| Managed .NET DLL | bin/Release/net48/*.dll |
Confirm assemblies are strong-name signed and pass NETLOAD in GstarCAD 2027. |
| AutoLISP / VLX | build/dist/*.vlx or *.lsp |
Verify clean loading in Startup Suite (APPLOAD) with zero console syntax errors. |