Artículo técnico

FontIndex de BIFF8 se salta el 4: rich text runs en HotXLS

Un libro BIFF8 con ocho registros FONT contiene un registro XF cuyo campo de fuente dice 8. Cuente desde cero y eso es un slot más allá del final de la tabla, y sin embargo Excel renderiza la celda con la octava fuente sin quejarse. El valor es legal: [MS-XLS] §2.5.129 numera los primeros cuatro registros FONT de 0 a 3, se salta el 4 por completo y numera cada registro posterior por su posición base uno

Así que el quinto registro FONT es ifnt 5, y un archivo bien formado nunca necesita un valor mayor que su cantidad de registros FONT. La regla se lee como un typo de la especificación, que es justamente por lo que la gente la "corrige", y como los formatos de celda, el rich text de los strings compartidos y los runs de comentarios llevan todos el mismo tipo FontIndex, una lectura que difiere entre rutas ata algunas fuentes correctamente y otras un registro corridas. Pertenece a la misma familia que las rarezas de longitud y codificación de decodificar cch y fHigh de XLUnicodeString en BIFF8 — el archivo está bien, la lectura no

Qué dice [MS-XLS] §2.5.129, y cómo comprobarlo en un archivo real

[MS-XLS] §2.5.129 define FontIndex como una posición de registro con un hueco. Los valores por debajo de 4 son base cero, los valores por encima de 4 son base uno, y el valor 4 NO DEBE usarse. Los registros XF apuntan a las fuentes con él, las entradas FormatRun de un string compartido con rich text lo usan, y también los runs de formato TXO descritos en §2.5.272

No hace falta creerle a la especificación a ciegas. Vuelque un .xls que el propio Excel guardó con cualquier visor de registros BIFF, cuente los registros FONT (tipo de registro $0031) y luego recorra el campo de fuente al inicio de cada registro XF ($00E0). El valor más alto se mantiene dentro de la cantidad de registros y el número 4 falta en la lista. Si encuentra un 4, o un valor por encima de la cantidad de FONT, el archivo lo escribió algo que no es Excel y su numeración de fuentes merece una mirada más atenta. Para una herramienta de diagnóstico o una prueba, todo el mapeo cabe en dos funciones

// Helpers propios, no son parte de ninguna biblioteca
// [MS-XLS] 2.5.129 FontIndex: 0..3 base cero, > 4 base uno, 4 inválido
function FontIndexToRecordNo(Ifnt: Word): Integer;  // registro FONT base 1
begin
  if Ifnt < 4 then
    Result := Ifnt + 1
  else if Ifnt > 4 then
    Result := Ifnt
  else
    Result := -1;  // 4 no debe ocurrir
end;

function RecordNoToFontIndex(RecordNo: Integer): Word;
begin
  if RecordNo <= 4 then
    Result := RecordNo - 1
  else
    Result := RecordNo;
end;
Mapeo FontIndex según MS-XLS 2.5.129 donde ifnt 0 a 3 son posiciones de registro FONT base cero, ifnt 5 en adelante son base uno y el valor 4 nunca ocurre, con la conversión FontIndexToRecordNo
El quinto registro FONT es ifnt 5, así que en un archivo con N registros FONT el mayor ifnt legal es N y el valor 4 nunca se almacena

Cómo numera HotXLS las fuentes en registros XF y runs de rich text

HotXLS lee y escribe cada referencia a fuente BIFF8 con la numeración de la especificación. Al guardar, la tabla de fuentes se compacta a las fuentes que algo referencia de verdad, y la posición de cada fuente sobreviviente se convierte en un FontIndex: las posiciones 1 a 4 se escriben como 0 a 3, la posición 5 en adelante sale sin cambios. La carga lo invierte, así que cualquier valor de 5 o más baja en uno para encontrar la fuente en memoria y cualquier cosa por debajo de 5 se queda donde está. La misma conversión se aplica a los registros XF, a los runs de rich text de la tabla de strings compartidos, a los runs de comentarios y cuadros de texto, y a las referencias a fuentes dentro de los registros de gráficos clásicos

Para el código de aplicación la parte visible es TextRuns en TXLSComment y TXLSTextBox. TextRuns.FontIndex[I] devuelve la numeración del archivo exactamente como se leyó, con el 4 salteado. Los índices de run son base 1, y CharIndex[I] es el offset de carácter donde arranca el run I. Exponer el número del archivo en lugar de un slot de tabla base cero es el mejor valor por defecto aquí: lo que la API reporta coincide con lo que muestra un volcado de registros. El costo es una llamada al helper de arriba antes de tratar el valor como una posición de tabla

var
  Book: IXLSWorkbook;
  Note: TXLSComment;
  I: Integer;
  Ifnt: Word;
begin
  Book := TXLSWorkbook.Create;
  if Book.Open('review-notes.xls') <> 1 then
    raise Exception.Create('Cannot open review-notes.xls');
  Note := Book.Sheets[1].Range['C2', 'C2'].Comment;
  if Note <> nil then
    for I := 1 to Note.TextRuns.Count do
    begin
      Ifnt := Note.TextRuns.FontIndex[I];   // numeración de archivo, se salta el 4
      // su propio chequeo de sanidad: 4 significa que el archivo rompe 2.5.129
      if Ifnt = 4 then
        raise Exception.CreateFmt('Run %d uses invalid ifnt 4', [I]);
      Writeln(Format('run %d at char %d: ifnt %d = FONT record #%d',
        [I, Note.TextRuns.CharIndex[I], Ifnt, FontIndexToRecordNo(Ifnt)]));
    end;
end;

Después de un guardado, el número almacenado para un run puede diferir del que usted leyó o fijó. El guardado renumera los runs junto con la tabla de fuentes compactada, así que el número cambia y la fuente a la que apunta no

Por qué un arreglo base cero corre todas las fuentes personalizadas

La trampa suele empezar con un reporte de bug que parece razonable. Alguien vuelca un libro con ocho registros FONT, ve un XF apuntando a la fuente 8, concluye que el escritor produjo un índice fuera de rango y cambia tanto el escritor como el lector a aritmética base cero simple. El test de round trip sigue pasando, porque el escritor parchado y el lector parchado coinciden entre sí. Excel no coincide. Un archivo escrito así guarda la primera fuente personalizada como ifnt 4, que Excel resuelve a la fuente por defecto, y cada fuente personalizada posterior cae un registro antes. Leer los archivos del propio Excel va en la dirección contraria: cada fuente se ata un registro tarde

La lectura errada base cero en la que un escritor y un lector tratan valores FontIndex base uno como base cero, guardando la primera fuente personalizada como el prohibido ifnt 4 que Excel resuelve a la fuente por defecto y dejando cada fuente posterior un registro antes mientras los round trips entre ambos siguen pasando
Un escritor y un lector que comparten la misma lectura errada pasan todo test de guardar y reabrir, mientras cada fuente que Excel abre cae un registro corrida

Dos señales delatan la lectura errada antes de que se publique. Una es un test que afirma ifnt < FontCount. Parece un chequeo de límites, y en realidad deja escrita la lectura errada como requisito. Un test que mapea cada ifnt escrito de vuelta a un nombre de registro FONT a través de la fórmula de la especificación atrapa el corrimiento en su primera corrida

La otra señal es código que se contradice a sí mismo. Un lector y escritor BIFF8 completo aplica la regla skip-4 en varios lugares: salida de XF, entrada de XF, remapeo de runs de strings compartidos, runs de comentarios, registros de fuentes de gráficos. Cuando un cambio pasa algunos de ellos a numeración base cero y deja el resto en paz, los sitios sin tocar son evidencia, así que sospeche del cambio antes de sospechar de ellos. Un cambio parcial puede esconderse mucho tiempo, porque las fuentes usadas en rich text suelen estar referenciadas también por algún formato de celda

¿Por qué los runs de fuentes de comentarios se rompen solo en el segundo guardado?

Los runs de comentarios y cuadros de texto pueden sobrevivir un guardado y romperse en el siguiente cuando se juntan dos hábitos del escritor. El primero es la poda asimétrica: mantener los primeros N-1 registros FONT en su lugar incondicionalmente y soltar solo el último cuando ningún XF lo referencia. El segundo es reescribir los runs de formato TXO ([MS-XLS] §2.4.329) byte a byte sin renumerarlos. Cada hábito pasa por sí solo un test de un solo guardado. Juntos preparan una pérdida de fuente que espera una generación

La razón está en lo que Excel escribe. Los archivos .xls hechos por Excel suelen terminar con una fuente final sin referencias; en un sistema con locale chino es una DengXian de 9 pt. En el primer guardado, la fuente que solo usa un run de comentario nunca es, por lo tanto, la última, y nada se mueve visiblemente. Ese guardado sí suelta la fuente final y promueve la fuente solo de comentario a la última posición. El segundo guardado encuentra una última fuente sin referencia de XF y la descarta. El ifnt del run apunta ahora más allá del final de la tabla, y Excel cae a la fuente por defecto. Si el libro ganó una fuente en el medio, el run se ata en cambio a la recién llegada. Las notas que se abren, se anotan y se guardan una y otra vez, como las de construir un flujo de revisión con comentarios e hipervínculos, son donde esto aparece primero

Tabla de fuentes a lo largo de dos guardados donde el registro FONT final sin referencias que Excel escribe cae primero, la fuente solo de comentarios pasa a ser la última y luego se descarta en el segundo guardado cuando los runs de formato TXO se reescriben sin contarlos como referencias a fuentes
El primer guardado se ve limpio porque la fuente final absorbe la pérdida; la fuente del comentario solo desaparece en el segundo, así que un chequeo de fuentes tiene que abarcar más de un guardado

HotXLS maneja los runs de comentarios y cuadros de texto de la misma manera que los runs de strings compartidos. Antes de compactar la tabla de fuentes, cada run de cada hoja se convierte de su FontIndex skip-4 a un slot de tabla y se cuenta como referencia, lo que conserva una fuente que solo un run usa. A la salida, los runs pasan por la misma tabla de slot a índice guardado que renumera los registros XF. La entrada TxOLastRun de cierre no lleva fuente y se escribe tal como se leyó. Por esa renumeración, comparar valores de FontIndex antes y después de un guardado no le dice nada; compare los nombres de fuente a los que resuelven

Copias, inserciones de filas y runs que cruzan libros

En el motor clásico, Range.Copy, CopyRange, Sheets.AddCopy y los desplazamientos de celdas detrás de Range.Insert y Range.Delete pasan todos por una misma ruta de copia de celdas, y un desplazamiento es solo una copia seguida de un limpiado. Una copia que llevara solo el texto y el autor del comentario convertiría una nota de dos runs en una nota de una sola fuente después de una simple inserción de fila, sin que el usuario tocara el comentario en absoluto

HotXLS copia el offset de inicio y la fuente de cada run junto con el texto. Dentro de un mismo libro el FontIndex se reutiliza tal cual. Entre libros la fuente se mueve por valor: el número skip-4 se convierte a un slot, la fuente se empareja o se agrega en la tabla de fuentes destino por sus atributos, y el slot resultante se convierte de vuelta a numeración de archivo. El rich text de los strings compartidos pasa por la misma conversión cuando Sheets.AddCopy copia una hoja a otro libro, así que los dos tipos de runs no pueden separarse. El lado de la tabla de fuentes sigue el mismo enfoque por valor que el lado de fórmulas cubierto en copia entre libros y re-enlace de fórmulas

Dos casos de borde vale la pena conocer cuando escriba pruebas para esto:

  • Un pegado in situ, donde origen y destino resuelven al mismo comentario, conserva sus runs; nada se limpia antes de haberse leído
  • Sheets.AddCopy también copia los comentarios anclados en celdas que no tienen registro de celda almacenado, que un bucle solo sobre las celdas almacenadas pasaría por alto

En el motor XLSX, las copias clonan los runs de comentarios por valor, y la parte de comentarios se lee y escribe con rFont, strike, u y vertAlign. El nombre de fuente, el tachado, el subrayado y el ajuste de superíndice o subíndice de un run vuelven, por lo tanto, intactos después de guardar y reabrir

Una prueba de regresión que sobrevive a la renumeración

Cada trampa de este artículo pasa una prueba en memoria. La lectura errada base cero vive en un escritor y un lector aparejados, la pérdida de la fuente del comentario necesita dos guardados, y los runs de comentarios perdidos en XLSX solo aparecen tras una reapertura. Así que la prueba tiene que reabrir desde disco, correr al menos dos generaciones de guardado y verificar la estructura de los runs en lugar de los números de fuente crudos. Parta de un libro que el propio Excel guardó, con un comentario de dos runs en C2 cuyo segundo run usa una fuente que nada más en el archivo referencia; esa es la fuente que el segundo guardado de otro modo soltaría

procedure CheckNoteAcrossTwoSaves(const SrcFile, Out1, Out2: string);
var
  Book: IXLSWorkbook;
  Note: TXLSComment;
  RunCount: Integer;
  SecondRunAt: Word;
begin
  // Las llamadas Assert son sus propios chequeos de prueba
  Book := TXLSWorkbook.Create;
  Assert(Book.Open(SrcFile) = 1);          // guardado por Excel, C2 tiene dos runs
  Note := Book.Sheets[1].Range['C2', 'C2'].Comment;
  Assert(Note <> nil);
  RunCount := Note.TextRuns.Count;
  SecondRunAt := Note.TextRuns.CharIndex[2];

  Book.Sheets[1].Range['C2', 'C2'].Copy(Book.Sheets[1].Range['E5', 'E5']);
  Book.Sheets[1].Range['C1', 'C1'].Insert(xlShiftDown);   // C2 pasa a C3
  Assert(Book.SaveAs(Out1) = 1);

  Book := TXLSWorkbook.Create;               // generación dos
  Assert(Book.Open(Out1) = 1);
  Assert(Book.SaveAs(Out2) = 1);

  Book := TXLSWorkbook.Create;               // reabrir, nunca confíe en la memoria
  Assert(Book.Open(Out2) = 1);
  Note := Book.Sheets[1].Range['C3', 'C3'].Comment;
  Assert((Note <> nil) and (Note.TextRuns.Count = RunCount));
  Assert(Note.TextRuns.CharIndex[2] = SecondRunAt);
  Assert(Note.TextRuns.FontIndex[2] <> 4);
  Note := Book.Sheets[1].Range['E5', 'E5'].Comment;
  Assert((Note <> nil) and (Note.TextRuns.Count = RunCount));
end;

El conteo de runs y los offsets de inicio atrapan las notas aplanadas. La fuente en sí necesita un paso más fuera de la prueba: abra Out2 en un visor de registros, pase el ifnt de cada run por FontIndexToRecordNo y confirme que el registro FONT en el que cae lleva el mismo nombre de fuente que en el archivo fuente. En Excel, una fuente perdida aparece como la tipografía por defecto en el segundo run de la nota de C3

El XLS clásico todavía aparece en muchos proyectos Delphi y C++Builder, y cada consumidor de fuentes de un archivo BIFF8 tiene que estar de acuerdo con §2.5.129 para que la salida se abra correctamente en Excel. HotXLS, el componente de hojas de cálculo para Delphi, aplica la numeración skip-4 en formatos de celda, strings compartidos, comentarios, cuadros de texto y gráficos, renumera los runs en cada guardado y los mueve por valor entre libros, y lee y escribe tanto XLS como XLSX sin Excel ni automatización OLE