Thema: Makros · CALL · END · Arrays
Gilt für: Archicad ab Version 10 (Rückgabewerte aus Makros)

Problem

Ein Makro soll zwei Arrays an das aufrufende Objekt zurückgeben:

GDL
! Makro, Parameter-Script
! www: Integer-Array [4] = 1, 2, 3, 4
! qqq: Längen-Array [2] = 1, 2
END www, qqq
GDL
! Hauptobjekt, Parameter-Script
CALL "Makro_Returner" PARAMETERS RETURNED_PARAMETERS www, qqq
PARAMETERS www = www, qqq = qqq

Ergebnis: www enthält sechs Werte (1, 2, 3, 4, 1, 2), qqq bleibt leer. Kein Compilerfehler.

Ursache

END v1, v2, … gibt keine Strukturen zurück, sondern eine flache Werteliste. Arrays werden dabei elementweise aneinandergereiht – aus END www, qqq wird 1, 2, 3, 4, 1, 2.

Die Verteilung auf die Empfänger regelt die GDL Reference (CALL):

„The returned values will be stored in these variables in the order they are returned in the called macro. […] If one of the variables in the caller is a dynamic array, all subsequent values will be stored in it.“

Array-Parameter sind dynamische Arrays. Der erste Array-Empfänger nimmt deshalb alle restlichen Werte auf; jeder weitere Empfänger geht leer aus.

Die Namen der Empfänger spielen keine Rolle. Das Makro liefert nur Werte, keine Namen; RETURNED_PARAMETERS leitet lediglich die Liste der Empfangsvariablen im aufrufenden Objekt ein.

Muster: Längen-Präfix

  1. Makro gibt zuerst die Länge jedes Arrays zurück, dann die Arrays.
  2. Hauptobjekt empfängt alles in einem lokalen dynamischen Array.
  3. Hauptobjekt teilt anhand der Längen wieder auf.
GDL
! Makro, Parameter-Script
END VARDIM1(www), VARDIM1(qqq), www, qqq
GDL
! Hauptobjekt, Parameter-Script
DIM _ret[]
CALL "Makro_Returner" PARAMETERS RETURNED_PARAMETERS _ret

nW = _ret[1]
nQ = _ret[2]

DIM _w[], _q[]
FOR i = 1 TO nW
    _w[i] = _ret[2 + i]
NEXT i
FOR i = 1 TO nQ
    _q[i] = _ret[2 + nW + i]
NEXT i

PARAMETERS www = _w, qqq = _q

Belegung von _ret:

Index Inhalt
1 VARDIM1(www) = 4
2 VARDIM1(qqq) = 2
3 … 6 www[1..4]
7 … 8 qqq[1..2]

Verallgemeinerung auf n Arrays

Bei mehr als zwei Arrays einen mitlaufenden Versatz verwenden statt verschachtelter Indexformeln:

GDL
! n Längen am Anfang von _ret, danach die Werte
_off = n
FOR i = 1 TO nA
    _a[i] = _ret[_off + i]
NEXT i
_off = _off + nA

FOR i = 1 TO nB
    _b[i] = _ret[_off + i]
NEXT i
_off = _off + nB
! … usw. für jedes weitere Array

Ändern sich die Array-Größen im Makro, bleibt das Hauptobjekt unverändert gültig.

Gemischte Typen

Zahlen- und Text-Arrays lassen sich gemeinsam übertragen. GDL Reference (DIM):

„Array elements can be of different simple types (numerical, string, group). […] Parameter and global variable arrays cannot be of mixed type.“

  • Das lokale Sammel-Array _ret darf gemischt sein.
  • Die Ziel-Parameter-Arrays erhalten jeweils nur Werte eines Typs – die Längen trennen die Abschnitte eindeutig.
  • Typen werden bei der Rückgabe nicht geprüft; die Empfangsvariable übernimmt den Typ des zurückgegebenen Werts (GDL Reference, CALL).

Randbedingungen

Punkt Verhalten
Deklaration Empfangs-Array vor dem CALL mit DIM _ret[] anlegen; Größe passt sich an
2D-Arrays werden zeilenweise flach übertragen; als Länge Zeilen × Spalten voranstellen, Struktur im Hauptobjekt per Schleife wiederherstellen
Mehr Empfänger als Werte überzählige Empfänger werden auf Ganzzahl 0 gesetzt
Obergrenze max. 32 767 Rückgabewerte
Kontext Aufruf aus dem Parameter-Script führt im Makro nur Master- und Parameter-Script aus – das END muss dort erreichbar sein
Platzierbares Makro Compiler-Warnung „Placeable symbol called“; Daten-Makros als nicht platzierbar anlegen

Quellen

  • GDL Reference Guide: CALL, DIM, END / EXIT
  • selfGDL: CALL, END / EXIT