filmopen_fdx

A snapshot

This specification is a copy of docs/software/packages/filmopen_fdx.md in the application’s repository, taken at commit 0b4fe88 of 11 November 2026. It is imported byte for byte and is not edited here; a change is made there, and arrives with the next snapshot.

Generated by scripts/package_digest.py; regenerate, never edit.

A pure Dart screenplay importer. importScriptFile(path, author:, epochLabel:) reads a bounded local file in an isolate and returns a ScriptImportResult: its in-memory source, project version and warning codes. Content selects the reader, including content in a renamed file; the extension only supplies the fallback project name. The store persists the result before state opens it.

pure Dart. 18 files, 2,172 lines under lib/; 116 tests in 11 files. Barrel: lib/filmopen_fdx.dart.

Depends on

• filmopen_format — uses AllocatedId, Author, EntityType, EpochDeclaration, MemoryProjectSource, ShortName, VersionStem, encodeEpochs, encodeNextEpoch, nextEpochKey
• filmopen_store — uses AppLog, rfc3339Now, writeImportedProject

Third-party: archive, pdfium_dart, ffi, xml.

Used by

filmopen_state

Public API

What the barrel exports, file by file. A name is class, enum, mixin, extension, typedef, a top-level function, getter, setter or variable; under a class, its public constructors, fields, getters, setters and methods.

lib/src/import_file_stub.dart

• function Future<ScriptImportResult> importScriptFile(String path, { required Author author, required String epochLabel, }) — Local file paths cannot be imported on this platform.

lib/src/import_result.dart — only ScriptImportResult, ScriptImportException

• class ScriptImportException — An import failure carrying a stable code, decision reason and worker diagnostics.
  • const ScriptImportException(this.code, {this.reason, this.events = const []}) — Creates a refusal with a stable diagnostic code.
  • final String code — The reason: invalid_xml, not_fdx, empty_script, too_large, unsupported_encoding, read_failed, not_screenplay, unavailable or failed.
  • final String? reason — The concrete decision or failing stage, for diagnostics.
  • final List<Map<String, Object?>> events — Events recorded before this refusal or unexpected failure.
• class ScriptImportResult — A complete, validated project ready to persist and open.
  • const ScriptImportResult({required this.source, required this.project, required this.warnings}) — Keeps the in-memory project and any recoverable conversion diagnostics.
  • final MemoryProjectSource source — Every JSON file of the imported project, written through the store.
  • final VersionStem project — The creator’s project version to open after persistence.
  • final List<String> warnings — Unique diagnostic codes; screenplay words belong in structured events.

Internal

Files under lib/ the barrel does not reach; nothing outside the package may import them.

• lib/src/converter.dart: convertScript, _children, _all, _text, _key, _cue, cueSpeaker, _id, _times, _timeWord, _xmlJson, _Resource, +1
• lib/src/detect.dart: detectBinary, detectText
• lib/src/docx_reader.dart: _children, _child, _attr, _key, _indent, readDocx
• lib/src/elements.dart: ScriptKind, screenplayStyle, ScriptElement, ScriptDocument
• lib/src/fdx_reader.dart: readFdx, _xmlCharacters, _children, _text, _paragraphs
• lib/src/fountain_reader.dart: readFountain
• lib/src/import_file_io.dart: importScriptFile, _recognise, _decode, _replay
• lib/src/layout.dart: _cueOffset, _number, _heading, _capitals, _cue, _slug, readLayout, classifyRows, _prepare
• lib/src/osf_reader.dart: readOsf
• lib/src/paragraph_reader.dart: readParagraphs
• lib/src/pdf_text.dart: PdfOpenException, PdfText, PdfPage, PdfRow, PdfRun
• lib/src/pdf_text_io.dart: _libraryIdentity, _pdfium, readPdfText, _pdfiumError, _misreadPunctuation, _Glyph, _median, _rows
• lib/src/rtf_reader.dart: _high, _ansi, _control, readRtf
• lib/src/zip_reader.dart: readZip