Artículo técnico

FontIndex BIFF8 se salta el 4: runs enriquecidos en HotXLS

Un libro BIFF8 con ocho records FONT contiene un record XF cuyo campo de fuente lee 8. Contando desde cero, eso es una posición 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 records FONT del 0 al 3, se salta el 4 por completo y numera cada record posterior por su posición basada en uno

Así que el quinto record FONT es ifnt 5, y un fichero bien formado nunca necesita un valor mayor que su conteo de records FONT. La regla suena como una errata de la especificación, que es justo por lo que la gente la "corrige", y como los formatos de celda, el texto enriquecido de cadenas compartidas y los runs de comentarios llevan todos el mismo tipo FontIndex, una lectura que difiera entre caminos liga unas fuentes bien y otras con un record de desfase. Es de la misma familia que las rarezas de longitud y codificación de decodificar cch y fHigh de XLUnicodeString en BIFF8 — el fichero está bien, la lectura que se hace de él no

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

[MS-XLS] §2.5.129 define FontIndex como una posición de record con un agujero. Los valores por debajo de 4 son basados en cero, los valores por encima de 4 son basados en uno, y el valor 4 NO DEBE usarse. Los records XF apuntan a fuentes con él, las entradas FormatRun de una cadena compartida enriquecida lo usan, y también los runs de formateo TXO descritos en §2.5.272

No hace falta quedarse con la palabra de la especificación. Vuelca un .xls que el propio Excel guardó con cualquier visor de records BIFF, cuenta los records FONT (tipo de record $0031) y luego escanea el campo de fuente al principio de cada record XF ($00E0). El valor más alto se queda dentro del conteo de records y el número 4 brilla por su ausencia en la lista. Si encuentras un 4, o un valor por encima del conteo de FONT, el fichero lo escribió algo que no es Excel y su numeración de fuentes merece una mirada de cerca. Para una herramienta de diagnóstico o un test, el mapeo entero cabe en dos funciones

// Tus propios ayudantes, no forman parte de ninguna biblioteca
// [MS-XLS] 2.5.129 FontIndex: 0..3 basados en cero, > 4 basados en uno, 4 inválido
function FontIndexToRecordNo(Ifnt: Word): Integer;  // record FONT basado en uno
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 de FontIndex según MS-XLS 2.5.129 donde ifnt 0 a 3 son posiciones de record FONT basadas en cero, ifnt 5 y superiores son basadas en uno y el valor 4 nunca ocurre, con la conversión FontIndexToRecordNo
El quinto record FONT es ifnt 5, así que en un fichero con N records FONT el mayor ifnt legal es N y el valor 4 nunca se almacena

Cómo numera HotXLS las fuentes en records XF y runs de texto enriquecido

HotXLS lee y escribe toda referencia de fuente BIFF8 en numeración de 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 superviviente 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 uno para encontrar la fuente en memoria y todo lo que esté por debajo de 5 se queda donde está. La misma conversión se aplica a los records XF, a los runs de texto enriquecido de la tabla de cadenas compartidas, a los runs de comentarios y cuadros de texto, y a las referencias de fuente dentro de los records 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 fichero exactamente como se leyó, con el 4 saltado. Los índices de run son basados en uno, y CharIndex[I] es el offset de carácter donde empieza el run I. Exponer el número de fichero en lugar de una posición de tabla basada en cero es aquí la mejor opción por defecto: lo que reporta la API coincide con lo que muestra un volcado de records. El coste es una llamada al ayudante de arriba antes de tratar el valor como 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 del fichero, 4 saltado
      // tu propia comprobación de cordura: 4 significa que el fichero 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;

Tras un guardado, el número almacenado para un run puede diferir del que leíste o fijaste. El guardado reenumera 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 basado en cero desplaza cada fuente personalizada

La trampa suele empezar con un informe de fallo de aspecto razonable. Alguien vuelca un libro con ocho records FONT, ve un XF apuntando a la fuente 8, concluye que el writer produjo un índice fuera de rango, y cambia tanto el writer como el reader a aritmética plana basada en cero. El test de ida y vuelta sigue pasando, porque el writer parcheado y el reader parcheado están de acuerdo entre sí. Excel no está de acuerdo. Un fichero escrito así almacena la primera fuente personalizada como ifnt 4, que Excel resuelve a la fuente por defecto, y cada fuente personalizada posterior aterriza un record antes. Leer los ficheros del propio Excel va en el otro sentido: cada fuente se liga un record tarde

La lectura equivocada basada en cero en la que un writer y un reader tratan valores FontIndex basados en uno como si fueran basados en cero, almacenando la primera fuente personalizada como el ifnt 4 prohibido que Excel resuelve a la fuente por defecto y aterrizando cada fuente posterior un record antes, mientras los viajes de ida y vuelta entre los dos siguen pasando
Un writer y un reader que comparten la misma lectura equivocada pasan todos los tests de guardar y reabrir, mientras que cada fuente que Excel abre aterriza con un record de desfase

Dos señales delatan la lectura equivocada antes de que salga. Una es un test que afirma ifnt < FontCount. Parece una comprobación de límites, y en realidad escribe la lectura equivocada como requisito. Un test que mapea cada ifnt escrito de vuelta a un nombre de record FONT por la fórmula de la especificación caza el desfase en su primera ejecución

La otra señal es código que discrepa de sí mismo. Un reader y writer BIFF8 completos aplica la regla de saltar el 4 en varios sitios: salida XF, entrada XF, remapeo de runs de cadenas compartidas, runs de comentarios, records de fuentes de gráficos. Cuando un cambio mueve algunos de esos sitios a numeración basada en cero y deja el resto tranquilo, los sitios intactos son la evidencia, así que sospecha del cambio antes que de ellos. Un cambio parcial puede esconderse mucho tiempo, porque las fuentes usadas en texto enriquecido suelen estar también referenciadas 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 a un guardado y romperse en el siguiente cuando se encuentran dos hábitos de escritura. El primer hábito es la poda asimétrica: mantener los primeros N-1 records FONT en su sitio sin condiciones y soltar solo el último cuando ningún XF lo referencia. El segundo es reescribir los runs de formateo TXO ([MS-XLS] §2.4.329) byte a byte sin reenumerarlos. Cada hábito pasa por sí solo un test de guardado único. Juntos montan una pérdida de fuente que espera una generación

El motivo está en lo que Excel escribe. Los ficheros .xls escritos por Excel acaban habitualmente con una fuente final sin referencias; en un sistema con locale chino es un DengXian de 9 pt. En el primer guardado, la fuente que solo usa un run de comentario nunca es la última, y nada se mueve a la vista. Ese guardado suelta la fuente final, eso sí, y promueve la fuente solo-de-comentario a la última posición. El segundo guardado encuentra una última fuente sin referencia 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 mientras tanto, el run se liga al recién llegado. Las notas que se abren, anotan y guardan una y otra vez, como las de construir un flujo de revisión con comentarios e hipervínculos, son donde esto asoma primero

Tabla de fuentes a lo largo de dos guardados donde el record FONT final sin referencias que escribe Excel se suelta primero, la fuente solo-de-comentario pasa a ser la última y luego se descarta en el segundo guardado cuando los runs de formateo TXO se reescriben sin contarlos como referencias de fuente
El primer guardado parece limpio porque la fuente final se lleva la pérdida; la fuente del comentario solo desaparece en el segundo, así que una comprobación de fuentes tiene que abarcar más de un guardado

HotXLS trata los runs de comentarios y cuadros de texto igual que los runs de cadenas compartidas. Antes de compactar la tabla de fuentes, cada run de cada hoja se convierte de su FontIndex con salto del 4 a una posición de tabla y se cuenta como referencia, lo que conserva una fuente que solo usa un run. A la salida, los runs pasan por la misma tabla de posición-a-índice-guardado que reenumera los records 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 te dice nada; compara los nombres de fuente a los que resuelven

Copias, inserciones de fila 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 un único camino de copia de celdas, y un desplazamiento es solo una copia seguida de un borrado. Una copia que llevara solo el texto y el autor del comentario convertiría una nota de dos runs en una nota de una fuente tras una sola inserción de fila, sin que el usuario tocara el comentario

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 con salto del 4 se convierte a posición, la fuente se busca o añade en la tabla de fuentes de destino por sus atributos, y la posición resultante se convierte de vuelta a numeración de fichero. El texto enriquecido de las cadenas compartidas 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 tratado en copia entre libros y reenlace de fórmulas

Dos casos de borde conviene conocer cuando escribas tests para esto:

  • Un pegado en el sitio, donde origen y destino resuelven al mismo comentario, conserva sus runs; nada se limpia antes de haberse leído
  • Sheets.AddCopy copia también comentarios anclados en celdas sin record de celda almacenado, que un bucle sobre las celdas almacenadas a solas se perdería

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 tanto intactos tras guardar y reabrir

Un test de regresión que sobrevive a la renumeración

Cada trampa de este artículo pasa un test en memoria. La lectura equivocada basada en cero vive en una pareja writer y reader a juego, la pérdida de la fuente de comentarios necesita dos guardados, y los runs de comentarios perdidos en XLSX solo asoman tras una reapertura. Así que el test tiene que reabrir desde disco, correr al menos dos generaciones de guardado y comprobar la estructura de los runs en lugar de los números de fuente en bruto. Parte 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 fichero referencia; esa es la fuente que el segundo guardado soltaría si no

procedure CheckNoteAcrossTwoSaves(const SrcFile, Out1, Out2: string);
var
  Book: IXLSWorkbook;
  Note: TXLSComment;
  RunCount: Integer;
  SecondRunAt: Word;
begin
  // Las llamadas Assert son comprobaciones de test tuyas
  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;               // reabre, nunca confíes 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 cazan las notas aplanadas. La fuente en sí necesita un paso más fuera del test: abre Out2 en un visor de records, pasa el ifnt de cada run por FontIndexToRecordNo y confirma que el record FONT donde aterriza lleva el mismo nombre de fuente que en el fichero de origen. En Excel, una fuente perdida se ve como la tipografía por defecto en el segundo run de la nota de C3

El XLS clásico sigue apareciendo en un montón de proyectos Delphi y C++Builder, y todo consumidor de fuentes de un fichero BIFF8 tiene que estar de acuerdo sobre §2.5.129 para que la salida abra bien en Excel. HotXLS, el componente de hojas de cálculo para Delphi, aplica la numeración con salto del 4 a través de formatos de celda, cadenas compartidas, comentarios, cuadros de texto y gráficos, reenumera los runs en cada guardado y los mueve por valor entre libros, y lee y escribe XLS y XLSX sin Excel ni automatización OLE