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 nå vere klar for den fjerde leksjonen — det første skriptet ditt i Script-Fu.

3.4.1. Vi lager eit tekstboks-skript

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

Script-Fu-meisteren, og kanskje også studenten hans, har sjølvsagt oppdaga at dette problemet kan løysast og automatiserast ved hjelp av Script-Fu.

Vi vill derfor lage eit skript som vi 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. Å redigere og lagre skripta dine

Til nå har du arbeidd på Script-Fu konsollen. Nå går vi over til å skriva dei som tekstfiler. Du kan bruke ein rein tekstbehandlar som ikkje legg inn ekstra koder i skriptet. Sjølv bruker eg Notepad++ sett til skriftkoden UTF-8, men det finst sikkert andre som fungerer like bra. (OA)

Kvar du lagrar filene, er eigentleg likegyldig. Har du tilgang til GIMP sine skriptmapper, kan du legge skripta dine der. Det beste er likevel å halde skripta dine langt borte frå dei ferdiginstallerte skripta, og heller lagra dei i eigne skriptmapper.

In the ~/.config/GIMP/2.10/ directory that GIMP made off of your home directory, you should find a directory called scripts. GIMP will automatically look in your ~/.config/GIMP/2.10/ directory for a scripts directory, and add the scripts in this directory to the Script-Fu database. You should place your personal scripts here.

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 gjere.

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

Vi må altså først definera hovudfunksjonen:

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

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

3.4.4. Namnereglar

Eigentleg godtar Scheme fleire måtar å skriva namn på. Har du gode vanar med deg frå andre språk, kan du stort sett nytta desse. Som i alle(?) programmeringsspråk, kan du ikkje dele opp eit namn med mellomrom. I Scheme er det difor vanleg praksis å gjere samansette ord meir forståelege ved å dela dei opp med bindestrek (-) slik du ser det er brukt i funksjonsnamnet. Dette vert av mange også brukt i parameternamna. Her har eg likevel nytta ein annan metode, nemleg å markera dei ulike orda med stor bokstav. I tillegg legg eg inn eit «in» framføre for å markera at dette er inndata og ikkje noko som er lagt til seinare. (Eg har lagt med til den vanen å bruke prefikset «the» framføre variablar som vert oppretta inne i skriptet).

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

3.4.5. Å registrere funksjonen

Nå må vi registrera funksjonen vår i GIMP. Dette gjer vi ved å kalle opp funksjonen script-fu-register. Når GIMP les inn eit skript, vil denne funksjonen legge skriptet inn i prosedyredatabasen. Du kan eigentleg skrive inn dette funksjonsoppkallet kvar som helst i skriptet, men det er vanleg å setje 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"                        ;func 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>/File/Create/Text")
      

Dersom du lagrar dette i skriptkatalogen som ei tekstfil med filutvidinga .scm og deretter vel FilterScript-FuOppdater skript, vil dette skriptet dukke opp i FilHent innTextText Box.

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 aktiverer prosedyrelesaren ( HjelpProsedyrelesar) vil du finna at scriptet ditt nå er registrert i databasen.

3.4.6. Å registrere skriptet

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

Dei nødvendige parametra

  • Namnet på funksjonen. Dette er funksjonen som vert aktivert 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 vi berre ein funksjon, «text-box», som så vart registrert.

  • Adressa i menyen skriptet vert sett inn i. Den eksakte adressa vert spesifisert på same måten som i Unix, med rot (startpunkt) i biletmenyen som <Image>. [6]

    Dersom skriptet ditt ikkje arbeider på eit eksisterande bilete, men lagar sitt eige bilete slik «Text Box» kjem til å gjere, kan du legge skriptet i biletmenyen. Utanom frå øvst i biletvindauget har du også tilgang til biletmenyen ved å høgreklikke i vindauget, ved å klikke menyknappen i øvre, venstre hjørne av biletvindauget eller ved å trykke F10.

    Skal skriptet derimot operera på eit bilete som vert redigert, må du legge skriptet inn i biletimenyen. Resten av banen peikar til menylistene, menyar og undermenyar. Vi registrerer difor skriptet i Text-menyen i menyen Hent inn i menyen Fil. [7] ( FilHent innTextText Box ).

    Du la kanskje merke til at text-undermenyen i Fil - Hent inn ikkje var der til å byrje med. GIMP oppretter nye menyar automatisk.

  • Ei beskriving av skriptet slik det skal visast i prosedyrelesarren.

  • Namnet ditt (dvs. forfattaren av skriptet).

  • Copyright-informasjon.

  • Datoen skriptet vart laga eller sist revidert.

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

Figur 13.4. Menyen for skriptet ditt.

Menyen for skriptet ditt.

3.4.7. Registrering av skriptparametra

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

Dette avsnittet i registreringsprosessen har dette formatet:

Parametertype

Penselnamn

Eksempel

SF-IMAGE

Dersom skriptet skal arbeide på eit opna bilete, må dette vere det første parameteret etter dei obligatoriske parametra. GIMP vil legge inn referanse til biletet i dette parameteret.

3

SF-DRAWABLE

Dersom skriptet skal arbeide på eit opna bilete, må dette vere det andre parameteret etter parameteret SF-IMAGE. Det refererer til eit aktivt lag. GIMP vil legge inn referanse til det aktive laget i dette parameteret.

17

SF-VALUE

Godtar tal og strengar. Merk at hermeteikn må markerast med \ framføre. Bruk heller SF-STRING.

42

SF-STRING

Godtar tekststrenger.

«Ein tekst»

SF-COLOR

Viser at her skal det vere 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-parameter API[8]

[Notat] Notat

Utanom dei parametertypane som er nemnde ovanfor, finst det også ei samling parametrar for interaktiv modus. Kvar av desse vil lage eit skjermelement («widget») i kontrolldialogen. Du kan finne ei beskriving av desse parametra og eksempel på bruk av dei i testskriptet plug-ins/script-fu/scripts/test-sphere.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
ElementPenselnamn
«merkelapp»Teksten framføre skjermelementet.
verdiStartverdi.
Øvre/nedrelower / upper : nedre/øvre grenseverdi (område for vala).
step_incstep_inc : Kor mykje auking/minking for kvart steg.
page_incpage_inc : Kor mykje auking/minking ved bruk av «page key».
sifferdigits : kor mange desimalar.
typeAnten 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
ElementPenselnamn
«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 desse returparametra:

(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
ElementPenselnamn
«merkelapp»Teksten framføre skjermelementet.
"fontname"Namn på standardskrift

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 parametrar til funksjonen vere '("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

Oppretter ein kombinasjonsboks i kontrolldialogen. Boksen viser alle oppføringane for den gjevne listetypen. Dette må vere namnet på ei registrert liste, utan «Gimp» framføre. Det andre parameteret spesifiserer førehandsvald verdi ved å bruke forkortinga for listeverdien.

SF-ENUM "Interpolation" '("InterpolationType" "linear")

Returverdien tilsvarer den valde listeverdien.



[6] Før versjon 2.6 kunne også <Toolbox> vert brukt, men sidan menyen i verktøykassa nå er fjerna, bør du ikkje bruke denne.

[7] I Mike sin originaltekst heiter det at menyen skal leggjast i Script-Fu-menyen i Utvidingar (Xtns), men frå og med versjon 2.6 vart menyane tatt bort frå verktøyskrinet og lagt inn i biletvindauget.

[8] Denne beskrivinga er ikkje med i originalversjonen.