3.4. Det første Script-Fu skriptet ditt
| 3. Ei innføring i Script-Fu |

### 3.4. Det første Script-Fu skriptet ditt

Du har kanskje hatt ein velfortent pause for å få igjen pusten? I alle fall burde du no vera klar for den fjerde leksjonen – det første skriptet ditt i Script-Fu.

#### 3.4.1. Me lagar eit tekstboks-skript

Eg bruker gjerne GIMP for å laga boksar med litt tekst og/eller bilete i for heimesidene mine. Ulempen er at eg aldri veit på førehand kor stor denne boksen vert, og har dermed problem med å vita kor stort startvindauge må vera. Alt er avhengig av skrifttype, skriftstorleik og eventuelle andre ting som skal vera med.

Dette problemet kan løysast og automatiserast med Script-Fu.

Me vill difor laga eit skript som me kallar «Text Box», og som lagar eit bilete i høveleg storleik til å passa pent rundt ei tekstlinje som brukaren skriv inn. Sjølvsagt kan brukaren også velja både type, storleik og farge for skrifta.

#### 3.4.2. Å redigera og lagra skripta dine

Opp til no har me arbeidd på Script-Fu-konsollen. No skal me gå over til å redigera skriptfiler. Skriptfiler er reine tekstfiler som kan redigerast i program for å redigera tekst eller kode. Kva namn du brukar på fila er ikkje så viktig, men bør vera slik at det er lett å finna igjen skriptet. Du gjev skriptfila utvidinga «.scm».

Kvar du lagrar skripta dine er eit spørsmål om preferanse. I GIMPs mappeinnstillingar kan du sjå kva mapper GIMP ser etter skript i. Det er også mogleg å leggja til ei ny mappe der. Til vanleg er mappa som GIMP lagrar sine eigne skript i ikkje det beste valet for å lagra skripta dine, men sjølvsagt brukar du staden som passar deg best.

#### 3.4.3. Det essensielle

Kvart einaste skript i Script-Fu må definera minst ein funksjon, og det er hovudfunksjonen for skriptet. Det er her du definerer kva skriptet skal gjera.

Alle skripta må også kunne registrerast i prosedyredatabasen slik at dei er tilgjengelege for GIMP.

Me må altså først definera hovudfunksjonen:

            (define (script-fu-text-box inText inFont inFontSize inTextColor))

Her har me definert ein ny funksjon som me har kalla `script-fu-text-box`. Funksjonen tek fire parametrar, som me seinare skal tilordna noko tekst («inText»), ein skrifttype («inFont»), ein skriftstorleik («inFontSize») og ein tekstfarge («inTextColor»). (Eigentleg kunne me like gjerne ha brukt norske namn her, men i programmering er det vanleg å bruka engelske namn slik at programmet er forståeleg også for andre). Funksjonen me har laga er førebels tom og gjer ikkje noko som helst. Så langt inkje nytt eller merkverdig.

#### 3.4.4. Namnereglar

Scheme sine namnekonvensjonar ser ut til å helst bruka små bokstavar med bindestrek, noko eg har følgd i namngjeving av funksjonen. Eg har likevel gått bort frå dette når det gjeld parameterane. Eg likar meir forklarande namn for parametrane og variablane mine, og legg dermed til "in" -prefikset til parametrane slik at eg raskt kan sjå at dei er verdiar som er sende inn i skriptet. Eg brukar prefikset "the" for variablar definert i skriptet.

GIMP vil helst gje skriptfunksjonane namnet `script-fu-abc` slik at dei vert lista ut under Script-Fu i prosedyredatabasen. Dette også for å skilja dei frå programtillegg.

#### 3.4.5. Å registrera funksjonen

No må me registrera funksjonen vår i GIMP. Dette gjer me ved å kalla opp funksjonen `script-fu-register`. Når GIMP les inn eit skript, vil denne funksjonen leggja skriptet inn i prosedyredatabasen. Du kan eigentleg skriva inn dette funksjonsoppkallet kvar som helst i skriptet, men det er vanleg å setja det heilt på slutten, etter alle dei andre kodane.

Her er utlistinga av programbiten som registrerer denne funksjonen (forklaringa kjem etterpå):

      (script-fu-register
        "script-fu-text-box"                        ;function name
        "Text Box"                                  ;menu label
        "Creates a simple text box, sized to fit\
          around the user's choice of text,\
          font, font size, and color."              ;description
        "Michael Terry"                             ;author
        "copyright 1997, Michael Terry;\
          2009, the GIMP Documentation Team"        ;copyright notice
        "October 27, 1997"                          ;date created
        ""                                      ;image type that the script works on
        SF-STRING      "Text"          "Text Box"   ;a string variable
        SF-FONT        "Font"          "Charter"    ;a font variable
        SF-ADJUSTMENT  "Font size"     '(50 1 1000 1 10 0 1)
                                                    ;a spin-button
        SF-COLOR       "Color"         '(0 0 0)     ;color variable
      )
      (script-fu-menu-register "script-fu-text-box" "<Image>/Filters/Tutorial")

Lagra desse funksjonane i ei tekstfil med filutvidinga `.scm` i skriptkatalogen med det same namnet som skriptfila og start GIMP på nytt. Det nye skriptet vil vert vist som Filter → Opplæring → Tekstboks.

Førebels gjer dette skriptet naturleg nok ingenting. Einaste er at du ser korleis skriptet vert registrert i GIMP og få ein kontroll på at du har gjort alt rett så langt.

Dersom du slår på prosedyrelesaren ( Hjelp → Prosedyrelesar) vil du finna at scriptet ditt no er registrert i databasen.

#### 3.4.6. Å registrera skriptet

For å registrera skriptet i GIMP, må me skriva inn dei sju obligatoriske parametrane, leggja til skriptet sine eigne parametrar og ei beskriving av skriptet, og endeleg dei verdiane du ønskjer skriptet skal opnast med i dei variable parametrane. Deretter kallar du opp funksjonen «script-fu-register» frå skriptet ditt.

Dei nødvendige parametrane

- Namnet på funksjonen. Dette er funksjonen som vert slått på når du kallar opp skriptet. (Inngangen til skriptet, om du vil). Dette er heilt nødvendig fordi du kan definera mange funksjonar innan same fila, og GIMP må vita kva for funksjonar som skal kallast opp. I eksemplet definerte me berre ein funksjon, «text-box», som så vart registrert.

- menu label er det namnet som vert vist i menyane. Kvar du legg desse er forklart i Del 3.4.9, «Registrera menyplasseringa».

- Ei beskriving av skriptet slik det skal visast i prosedyrelesaren.

- Namnet ditt (dvs. forfattaren av skriptet).

- Informasjon om Opphavsrett.

- Datoen skriptet vart laga eller sist revidert.

- Bilettypar skriptet kan brukast på. Dette kan vera RGB, RGBA, GRAY, GRAYA, INDEXED eller INDEXEDA. Eller ingen i det heile. I dette tilfellet opprettar skriptet sitt eige bilete, og treng såleis ikkje definera bilettype.

#### 3.4.7. Registrering av skriptparametra

Når me endeleg er ferdige med dei obligatoriske parameterane, er tida komen for dei skriptavhengige parameterane. Når me listar opp parameterane for skriptet, tek me også med kva for type dei er. Dette er for dialogvindauget som sprett opp når nokon vel skriptet ditt. I tillegg treng me også ein førehandsvald verdi for parameterane. Den verdien programmet vil nytta om brukaren ikkje gjer endringar.

Dette avsnittet i registreringsprosessen har dette formatet:

Parametertype | Penselnamn | Eksempel
--- | --- | ---
`SF-IMAGE` | Dersom skriptet skal arbeida på eit opna bilete, må dette vera den første parameteren etter dei obligatoriske parameterane. GIMP vil leggja inn referanse til biletet i denne parameteren. | 3
`SF-DRAWABLE` | Dersom skriptet skal arbeida på eit opna bilete, må dette vera den andre parameteren etter parameteren SF-IMAGE. Det refererer til eit gjeldande lag. GIMP vil leggja inn referanse til det gjeldande laget i denne parameteren. | 17
`SF-STRING` | Godtar tekststrenger. | «Ein tekst»
`SF-COLOR` | Viser at her skal det vera ein fargeverdi. | '(0 102 255)
`SF-TOGGLE` | Viser ein avkryssingsboks for å lesa inn ein logisk verdi. | TRUE eller FALSE (sant/usant)

#### 3.4.8. Script-Fu-parameteren API[5]

| Notat
Utanom dei parametertypane som er nemnde ovanfor, finst det også ei samling parametrar for interaktiv modus. Kvar av desse vil laga eit skjermelement («widget») i kontrolldialogvindauget. Du kan finna ei beskriving av desse parametrane og eksempel på bruk av dei i testskriptet `plug-ins/script-fu/scripts/test-sphere-v3.scm` som følgjer med kjeldekodene for GIMP.

Parametertype | Penselnamn
--- | ---

`SF-ADJUSTMENT`

Oppretter eit justeringselement i dialogen.

SF-ADJUSTMENT "label" '(value lower upper step_inc page_inc digits type)

Argumentliste for skjermelementet

Element | Penselnamn
--- | ---
«merkelapp» | Teksten framføre skjermelementet.
verdi | Startverdi.
nedre/øvre | lower / upper : nedre/øvre grenseverdi (område for vala).
step_inc | Increment/decrement verdi.
page_inc | Increment/decrement verdi ved bruk av «page key».
siffer | Digits: kor mange desimalar.
type | Anten SF-SLIDER, 0, SF-SPINNER eller 1

`SF-COLOR`

Oppretter ein fargeknapp i dialogvindauget.

SF-COLOR "label" '(red green blue)

eller

SF-COLOR "label" "color"

Argumentliste for skjermelementet

Element | Penselnamn
--- | ---
«merkelapp» | Teksten framføre skjermelementet.
'(red green blue) | Liste med ein verdi for kvar av komponentane raud, grøn og blå.
"color" | Fargenamn i CSS-notasjon.

`SF-FONT`

Oppretter eit område for å velje skrifttype. Namnet på skrifttypen vert returnert som ein streng. Det er oppretta to nye tekstprosedyrar for å forenkla bruken av dette returparametret:

(gimp-text-fontname image drawable x-pos y-pos text border antialias size unit font)

(gimp-text-get-extents-fontname text size unit font)

der fontname er namnet på skrifttypen. Storleiken som vert spesifisert i skriftnamnet vert ignorert. Denne verdien vert berre brukt i skrifttypeveljaren. Difor bør du helst setje denne til ein førehandvald verdi, for eksempel 24.

SF-FONT "label" "fontname"

Argumentliste for skjermelementet

Element | Penselnamn
--- | ---
«merkelapp» | Teksten framføre skjermelementet.
"fontname" | Namn på standardskrifta.

`SF-BRUSH`

Denne vil opprette eit område i kontrolldialogen som du kan klikke på for å få opp ei førehandsvising. Det vert også laga ein «...»-knapp. Når du klikkar på denne, kjem det opp ein meny der du kan velje pensel og endre innstillingane for denne.

SF-BRUSH "Brush" '("Circle (03)" 100 44 0)

Penseldialogen vert førehandssett med verdiane for "Circle (03)" dekkevne = 100, avstand = 44 og normal skrivemodus (verdi = 0).

Dersom du ikkje gjer endringar i denne, vil verdiane som vert sende vidare som ein parameter til funksjonen vera '("Circle (03)" 100 44 0).

`SF-PATTERN` | Denne vil opprette eit område i kontrolldialogen som du kan klikke på for å få opp ei førehandsvising av mønsterelementa. Det vert også laga ein «...»-knapp. Når du klikkar på denne, kjem det opp ein meny der du kan velje mønsterelement. SF-PATTERN "Pattern" "Maple Leaves" Denne vil returnere ein streng med namnet på mønsterelementet. I dette tilfellet «Maple Leaves».
`SF-GRADIENT` | Oppretter eit område i kontrolldialogen med ein knapp som inneheld ei førehandsvising av den valde fargeovergangen. Dersom du klikkar på knappen, kjem det opp ein dialog der du kan velje fargeovergang. SF-GRADIENT "Gradient" "Deep Sea" Denne vil returnere ein streng med namnet på fargeovergangen. I dette tilfellet «Deep Sea».
`SF-PALETTE` | Oppretter eit område i kontrolldialogen med ein knapp som inneheld namnet på den valde paletten. Klikk på knappen for å opna dialogen for å velje palett. SF-PALETTE "Palette" "Named Colors" Denne vil returnere ein streng med namnet på paletten. I dette tilfellet «Named Colors».
`SF-FILENAME` | Oppretter eit område i kontrolldialogen med ein knapp som inneheld eit filnamn. Klikk på knappen for å opna dialogen for å velje fil. SF-FILENAME "label" (string-append "" gimp-data-directory "/scripts/beavis.jpg") Denne vil returnere ein streng med filnamnet.
`SF-DIRNAME` | Berre brukbar i interaktiv modus. Liknar svært på SF-FILENAME, men du kan velje ein katalog i staden for ei fil. SF-DIRNAME "label" "/var/tmp/images" Denne vil returnere ein streng med katalognamnet.
`SF-OPTION` | Oppretter eit område i kontrolldialogen med ein kombinasjonsboks som viser dei valde innstillingane på listeform. Den første innstillinga er den førehandsvalde. SF-OPTION "label" '("option1" "option2") Returverdien er nummeret for den valde innstillinga. Teljinga byrjar frå 0.
`SF-ENUM` | Opprettar eit skjermelement i kontrolldialogvindauget. Skjermelementet viser alle oppføringane for den gjevne listetypen. Dette må vera namnet på ei registrert liste, utan «Gimp»-prefikset. Den andre parameteren spesifiserer standardverdien ved å bruka forkortinga for listeverdien. SF-ENUM "Interpolation" '("InterpolationType" "linear") Returverdien tilsvarer den valde listeverdien.

#### 3.4.9. Registrera menyplasseringa

Når skriptet er registrert, no me fortelja GIMP kva det skal vera i menyen.

Den beste menyplasseringa er avhengig av kva funksjon skriptet har. Dei fleste skripta er plasserte i menyane Filter og Fargar.

For det gjeldande skriptet, som lagar eit nytt bilete, vel me ein undermeny med Filter → Opplæring. Dette er det linja med `script-fu-menu-register`-funksjonen gjer. Dermed registrerte me tekstboksskriptet vårt her: Filter → Opplæring → Tekstboks.

Ein undermeny som du spesifiserer i skriptet og som ikkje finst, vert laga automatisk av GIMP.

[5] Denne bolken er ikkje med i originalversjonen.

3.3. Lister, lister og atter lister |  | 3.5. Leggja til tilleggsfunksjonar

Report a bug in GIMP Report a documentation error