layoutbridge-spm 0.0.1 → 1.0.0

package/indesign/commands/35-parents.js

@@ -0,0 +1,428 @@
+/* Bereich B – Musterseiten (parent pages) und Seitenzahl-Platzhalter. */
+
+/* ---------------------------------------------------- list_parent_pages */
+
+function idcMasterSpreadByName(doc, name) {
+  var spread, i;
+  try {
+    spread = doc.masterSpreads.itemByName(String(name));
+    if (spread && spread.isValid === true) { return spread; }
+  } catch (e) { /* weiter */ }
+  for (i = 0; i < doc.masterSpreads.length; i++) {
+    spread = doc.masterSpreads.item(i);
+    if (String(spread.name) === String(name)) { return spread; }
+  }
+  return null;
+}
+
+function idcMasterSpreadNames(doc) {
+  var names = [];
+  var i;
+  for (i = 0; i < doc.masterSpreads.length; i++) {
+    names.push(String(doc.masterSpreads.item(i).name));
+  }
+  return names;
+}
+
+/* ID des Musterbogens, der einer Seite zugewiesen ist, sonst null. */
+function idcAppliedMasterId(page) {
+  var master;
+  try {
+    master = page.appliedMaster;
+    if (master && master.isValid === true) { return Number(master.id); }
+  } catch (e) { /* keine */ }
+  return null;
+}
+
+IDC.register('list_parent_pages', { needs_document: true, read_only: true, ruler: 'page' },
+  function (ctx) {
+    var doc = ctx.doc;
+    var parents = [];
+    var applied = {};
+    var i, j, page, masterId, spread, entry, mpage, key, itemCount;
+
+    for (i = 0; i < doc.pages.length; i++) {
+      page = doc.pages.item(i);
+      masterId = idcAppliedMasterId(page);
+      if (masterId !== null) {
+        key = String(masterId);
+        if (!IDC.hasOwn(applied, key)) { applied[key] = []; }
+        applied[key].push(Number(page.id));
+      }
+    }
+
+    for (i = 0; i < doc.masterSpreads.length; i++) {
+      spread = doc.masterSpreads.item(i);
+      key = String(Number(spread.id));
+      entry = {
+        name: String(spread.name),
+        prefix: String(spread.namePrefix),
+        base_name: String(spread.baseName),
+        applied_to_page_ids: IDC.hasOwn(applied, key) ? applied[key] : [],
+        pages: []
+      };
+      for (j = 0; j < spread.pages.length; j++) {
+        mpage = spread.pages.item(j);
+        itemCount = 0;
+        try { itemCount = mpage.pageItems.length; } catch (e) { itemCount = 0; }
+        entry.pages.push({
+          page_id: Number(mpage.id),
+          index: j,
+          side: IDC.pageSide(mpage),
+          item_count: itemCount
+        });
+      }
+      parents.push(entry);
+    }
+    return { parent_pages: parents, count: parents.length };
+  });
+
+/* --------------------------------------------------- create_parent_page */
+
+/*
+ * Sitzung 24 (Befund aus dem Praxiseinsatz, E-79): Musterbogen, auf dem ein anderer
+ * beruht (based_on). Name mit Praefix oder "[None]"; null = nichts angegeben.
+ */
+function idcBasedOnArg(doc, name) {
+  var spread;
+  if (name === undefined || name === null) { return null; }
+  if (idcMeansNoParent(name)) { return { none: true, spread: null, name: '[None]' }; }
+  spread = idcMasterSpreadByName(doc, name);
+  if (spread === null) {
+    IDC.fail('not_found', 'No master page named "' + name + '" for based_on. Use the full name with prefix.',
+      { based_on: String(name), available: idcMasterSpreadNames(doc) });
+  }
+  return { none: false, spread: spread, name: String(spread.name) };
+}
+
+/* Musterbogen auf basedOn gruenden; Fehler als Warnung (der Bogen ist dann schon angelegt). */
+function idcApplyBasedOn(ctx, spread, basedOn) {
+  if (basedOn === null) { return; }
+  try {
+    if (basedOn.none) { spread.appliedMaster = NothingEnum.NOTHING; }
+    else { spread.appliedMaster = basedOn.spread; }
+  } catch (e) {
+    ctx.warn('The master page was created, but InDesign could not base it on "' + basedOn.name + '": ' + String(e.message ? e.message : e) +
+      ' – use apply_parent_to_page with one of its page_ids.');
+  }
+}
+
+/* Seitenzahl eines Musterbogens auf count bringen (am Ende anfuegen oder entfernen). */
+function idcSetMasterPageCount(ctx, spread, count) {
+  try {
+    while (spread.pages.length < count) { spread.pages.add(LocationOptions.AT_END); }
+    while (spread.pages.length > count) { spread.pages.item(spread.pages.length - 1).remove(); }
+  } catch (e) {
+    ctx.warn('Could not bring the master to ' + count + ' page(s): ' + String(e.message ? e.message : e));
+  }
+  if (spread.pages.length !== count) {
+    ctx.warn('The master has ' + spread.pages.length + ' page(s), not the ' + count + ' requested.');
+  }
+}
+
+/* Zahl der Objekte auf allen Seiten eines Musterbogens. */
+function idcMasterItemCount(spread) {
+  var count = 0, i;
+  for (i = 0; i < spread.pages.length; i++) {
+    try { count += spread.pages.item(i).pageItems.length; } catch (e) { /* weiter */ }
+  }
+  return count;
+}
+
+IDC.register('create_parent_page', { needs_document: true, read_only: false, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var baseName, prefix, facing, docFacing, spread, i, pageIds, fullName, pageCount, basedOn;
+    /* Sitzung 10 (Demo-Heft-Befund 1): InDesign springt auf die neue Musterseite; Ansicht merken. */
+    var keepView = idcKeepViewArg(args);
+    var view = null, viewRestored = null;
+
+    if (typeof args.base_name !== 'string' || args.base_name.length < 1 || args.base_name.length > 60) {
+      IDC.fail('invalid_argument', 'base_name is required (1 to 60 characters).', null);
+    }
+    baseName = args.base_name;
+    prefix = args.name_prefix === undefined || args.name_prefix === null ? null : String(args.name_prefix);
+    if (prefix !== null && !/^[A-Z]$/.test(prefix)) {
+      IDC.fail('invalid_argument', 'name_prefix must be a single capital letter (A-Z).', { name_prefix: prefix });
+    }
+    docFacing = doc.documentPreferences.facingPages === true;
+    facing = args.facing === undefined || args.facing === null ? docFacing : args.facing === true;
+    pageCount = null;
+    if (args.page_count !== undefined && args.page_count !== null) {
+      pageCount = args.page_count;
+      if (typeof pageCount !== 'number' || Math.floor(pageCount) !== pageCount || pageCount < 1 || pageCount > 10) {
+        IDC.fail('invalid_argument', 'page_count must be a whole number from 1 to 10 (InDesign allows at most 10 pages per spread).', { page_count: pageCount });
+      }
+      if (args.facing !== undefined && args.facing !== null && ((args.facing === true && pageCount === 1) || (args.facing === false && pageCount > 1))) {
+        IDC.fail('invalid_argument', 'facing ' + String(args.facing) + ' contradicts page_count ' + pageCount + '; pass only page_count.',
+          { facing: args.facing, page_count: pageCount });
+      }
+    }
+    basedOn = idcBasedOnArg(doc, args.based_on);
+
+    if (prefix !== null) {
+      fullName = prefix + '-' + baseName;
+      if (idcMasterSpreadByName(doc, fullName) !== null) {
+        IDC.fail('invalid_state', 'A master page named "' + fullName + '" exists already.',
+          { name: fullName, available: idcMasterSpreadNames(doc) });
+      }
+    }
+
+    if (keepView) { view = idcCaptureView(doc); }
+    try {
+      /* page_count: MasterSpreads.add(pagesPerSpread) – gilt auch in einseitigen Dokumenten (Sitzung 24). */
+      spread = pageCount === null ? doc.masterSpreads.add() : doc.masterSpreads.add(pageCount);
+      spread.baseName = baseName;
+      if (prefix !== null) { spread.namePrefix = prefix; }
+    } catch (e) {
+      IDC.fail('script_error', 'InDesign could not create the master page: ' + String(e.message ? e.message : e),
+        { base_name: baseName, name_prefix: prefix, page_count: pageCount });
+    }
+
+    if (pageCount !== null) {
+      idcSetMasterPageCount(ctx, spread, pageCount);
+    } else if (facing && !docFacing) {
+      ctx.warn('facing true requested, but the document has single pages; the master has one page. Pass page_count 2 for a two-page master.');
+    }
+    idcApplyBasedOn(ctx, spread, basedOn);
+    if (pageCount === null && !facing && spread.pages.length > 1) {
+      try {
+        while (spread.pages.length > 1) { spread.pages.item(spread.pages.length - 1).remove(); }
+      } catch (e2) {
+        ctx.warn('Could not reduce the master to a single page: ' + String(e2.message ? e2.message : e2));
+      }
+    }
+
+    pageIds = [];
+    for (i = 0; i < spread.pages.length; i++) { pageIds.push(Number(spread.pages.item(i).id)); }
+
+    if (view !== null) {
+      viewRestored = view.window === null ? null : idcRestoreView(view);
+    }
+
+    ctx.changes = { created_parent_page_ids: pageIds };
+    return {
+      name: String(spread.name),
+      prefix: String(spread.namePrefix),
+      base_name: String(spread.baseName),
+      page_ids: pageIds,
+      facing: spread.pages.length > 1,
+      page_count: spread.pages.length,
+      based_on: idcAppliedParentName(spread),
+      view_restored: viewRestored
+    };
+  });
+
+/* ------------------------------------------------ duplicate_parent_page */
+
+/*
+ * Sitzung 24 (E-79): Musterbogen mit allen Seiten und Objekten kopieren
+ * (MasterSpread.duplicate), dann umbenennen. Ohne base_name bleibt der
+ * Grundname der Vorlage, ohne name_prefix vergibt InDesign das naechste
+ * freie Praefix.
+ */
+IDC.register('duplicate_parent_page', { needs_document: true, read_only: false, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var source, baseName, prefix, fullName, copy, i, pageIds, sourceItems, copyItems;
+    var keepView = idcKeepViewArg(args);
+    var view = null, viewRestored = null;
+
+    if (typeof args.source_name !== 'string' || args.source_name.length < 1) {
+      IDC.fail('invalid_argument', 'source_name is required (full master name with prefix, e.g. "A-Grundlayout").', null);
+    }
+    source = idcMasterSpreadByName(doc, args.source_name);
+    if (source === null) {
+      IDC.fail('not_found', 'No master page named "' + args.source_name + '". Use the full name with prefix.',
+        { source_name: String(args.source_name), available: idcMasterSpreadNames(doc) });
+    }
+    baseName = args.base_name === undefined || args.base_name === null ? String(source.baseName) : args.base_name;
+    if (typeof baseName !== 'string' || baseName.length < 1 || baseName.length > 60) {
+      IDC.fail('invalid_argument', 'base_name must have 1 to 60 characters.', null);
+    }
+    prefix = args.name_prefix === undefined || args.name_prefix === null ? null : String(args.name_prefix);
+    if (prefix !== null && !/^[A-Z]$/.test(prefix)) {
+      IDC.fail('invalid_argument', 'name_prefix must be a single capital letter (A-Z).', { name_prefix: prefix });
+    }
+    if (prefix !== null) {
+      fullName = prefix + '-' + baseName;
+      if (idcMasterSpreadByName(doc, fullName) !== null) {
+        IDC.fail('invalid_state', 'A master page named "' + fullName + '" exists already.',
+          { name: fullName, available: idcMasterSpreadNames(doc) });
+      }
+    }
+    sourceItems = idcMasterItemCount(source);
+
+    if (keepView) { view = idcCaptureView(doc); }
+    try {
+      copy = source.duplicate();
+      if (IDC.isArray(copy)) { copy = copy[0]; }
+    } catch (e) {
+      IDC.fail('script_error', 'InDesign could not duplicate the master page "' + String(source.name) + '": ' + String(e.message ? e.message : e),
+        { source_name: String(source.name) });
+    }
+    try {
+      copy.baseName = baseName;
+      if (prefix !== null) { copy.namePrefix = prefix; }
+    } catch (e2) {
+      ctx.warn('The master page was duplicated as "' + String(copy.name) + '", but could not be renamed: ' + String(e2.message ? e2.message : e2));
+    }
+
+    pageIds = [];
+    for (i = 0; i < copy.pages.length; i++) { pageIds.push(Number(copy.pages.item(i).id)); }
+    copyItems = idcMasterItemCount(copy);
+    if (copyItems !== sourceItems) {
+      ctx.warn('The copy holds ' + copyItems + ' object(s), the source ' + sourceItems + ' – check it with get_page_state.');
+    }
+    if (view !== null) {
+      viewRestored = view.window === null ? null : idcRestoreView(view);
+    }
+
+    ctx.changes = { created_parent_page_ids: pageIds };
+    return {
+      name: String(copy.name),
+      prefix: String(copy.namePrefix),
+      base_name: String(copy.baseName),
+      page_ids: pageIds,
+      page_count: copy.pages.length,
+      source_name: String(source.name),
+      based_on: idcAppliedParentName(copy),
+      item_count: copyItems,
+      source_item_count: sourceItems,
+      view_restored: viewRestored
+    };
+  });
+
+/* --------------------------------------------------- apply_parent_to_page */
+
+function idcMeansNoParent(name) {
+  var text = String(name).toLowerCase();
+  return text === '[none]' || text === 'none' || text === 'ohne' || text === '[ohne]' || text === '';
+}
+
+IDC.register('apply_parent_to_page', { needs_document: true, read_only: false, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var found, page, spread;
+
+    if (args.page_id === undefined || args.page_id === null) {
+      IDC.fail('invalid_argument', 'page_id is required.', null);
+    }
+    if (args.parent_name === undefined || args.parent_name === null) {
+      IDC.fail('invalid_argument', 'parent_name is required (full name such as "A-Grundlayout", or "[None]" to detach).', null);
+    }
+    found = IDC.pageById(doc, args.page_id);
+    if (found === null) {
+      IDC.fail('not_found', 'No page with page_id ' + args.page_id + ' in this document.', { page_id: args.page_id });
+    }
+    page = found.page;
+
+    try {
+      if (idcMeansNoParent(args.parent_name)) {
+        page.appliedMaster = NothingEnum.NOTHING;
+      } else {
+        spread = idcMasterSpreadByName(doc, args.parent_name);
+        if (spread === null) {
+          IDC.fail('not_found', 'No master page named "' + args.parent_name + '". Use the full name with prefix.',
+            { parent_name: String(args.parent_name), available: idcMasterSpreadNames(doc) });
+        }
+        page.appliedMaster = spread;
+      }
+    } catch (e) {
+      if (e && e.isIdcError) { throw e; }
+      IDC.fail('script_error', 'InDesign could not apply the master page: ' + String(e.message ? e.message : e),
+        { page_id: args.page_id, parent_name: String(args.parent_name) });
+    }
+
+    ctx.changes = { modified_page_ids: [Number(page.id)] };
+    return {
+      page_id: Number(page.id),
+      parent_applied: idcAppliedParentName(page)
+    };
+  });
+
+/* ------------------------------------------- override_parent_item_on_page */
+
+IDC.register('override_parent_item_on_page', { needs_document: true, read_only: false, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var page, found, local;
+
+    page = idcDocumentPageById(doc, args.page_id, 'page_id');
+    if (args.parent_item_id === undefined || args.parent_item_id === null) {
+      IDC.fail('invalid_argument', 'parent_item_id is required.', null);
+    }
+    found = IDC.itemById(doc, args.parent_item_id, 'parent');
+    if (found === null) {
+      if (IDC.itemById(doc, args.parent_item_id, 'document') !== null) {
+        IDC.fail('invalid_state', 'Object ' + args.parent_item_id + ' lies on a document page, not on a master spread.',
+          { parent_item_id: args.parent_item_id });
+      }
+      IDC.fail('not_found', 'No object with id ' + args.parent_item_id + ' on any master spread.',
+        { parent_item_id: args.parent_item_id });
+    }
+
+    try {
+      local = found.item.override(page);
+      if (IDC.isArray(local)) { local = local[0]; }
+      local = IDC.concrete(local);
+    } catch (e) {
+      IDC.fail('invalid_state', 'InDesign could not override the master item on this page (is its master applied to the page, and does the item lie on the master page of the same side – left/right?): ' +
+        String(e.message ? e.message : e),
+        { page_id: Number(page.id), parent_item_id: args.parent_item_id });
+    }
+
+    ctx.changes = { created_frame_ids: [Number(local.id)] };
+    return {
+      frame_id: Number(local.id),
+      page_id: Number(page.id),
+      parent_item_id: Number(args.parent_item_id),
+      type: IDC.itemType(local)
+    };
+  });
+
+/* ------------------------------------------- insert_page_number_marker */
+
+IDC.register('insert_page_number_marker', { needs_document: true, read_only: false, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var found, frame, position, points, target;
+
+    if (args.frame_id === undefined || args.frame_id === null) {
+      IDC.fail('invalid_argument', 'frame_id is required.', null);
+    }
+    position = args.position === undefined || args.position === null ? 'end' : String(args.position);
+    if (position !== 'start' && position !== 'end') {
+      IDC.fail('invalid_argument', 'position must be "start" or "end".', { position: position });
+    }
+    found = IDC.itemById(doc, args.frame_id, 'any');
+    if (found === null) {
+      IDC.fail('not_found', 'No object with frame_id ' + args.frame_id + '.', { frame_id: args.frame_id });
+    }
+    frame = found.item;
+    if (!IDC.isTextFrame(frame)) {
+      IDC.fail('invalid_state', 'Object ' + args.frame_id + ' is not a text frame (' + IDC.className(frame) + ').',
+        { frame_id: args.frame_id });
+    }
+
+    try {
+      points = frame.insertionPoints;
+      target = position === 'start' ? points.item(0) : points.item(points.length - 1);
+      target.contents = SpecialCharacters.AUTO_PAGE_NUMBER;
+    } catch (e) {
+      IDC.fail('script_error', 'InDesign could not insert the page number marker: ' + String(e.message ? e.message : e),
+        { frame_id: args.frame_id });
+    }
+
+    ctx.changes = { modified_frame_ids: [Number(frame.id)] };
+    return {
+      frame_id: Number(frame.id),
+      position: position,
+      on_parent_page: found.on_parent
+    };
+  });