Gambas.CopyLeft.be/blog

1) Libraries

Bron: gambaswiki.org/wiki/doc/library

Library
Een library dient om gemeenschappelijk code tussen verschillende projecten te delen.

Een library is een Gambas programmma (executable), dat gebruikt kan worden in een ander project.

Voor eigen gebruik ga je dus steeds een library gebruiken, en geen component.

Locatie

Als een gambas project een library lib01 nodig heeft, wordt die gezocht op volgende plaatsen:

• 1) uitvoerbare projectdirectory/lib01.gambas
• 2) $XDG_DATA_HOME/gambas3/lib/vendorname/lib01:versie.gambas
• 3) ~/.local/share/gambas3/lib/vendorname/lib01:version.gambas
• 4) Project-Property_Tab_Library_directory-value/vendorname/lib01:versie.gambas
• 5) /usr/lib[/multiarch]/gambas3/vendorname/lib01:versie.gambas
• 6) /usr/bin/vendorname/lib01:versie.gambas

1. is de oudste manier
2./3. hangt af van het bestaan van $XDG_DATA_HOME, en gaat over installatie voor de user (single userwide copy; bv handig tijdens testen).
4. is een instelling in het gebruikend gambasproject (project eigenschappen)
5. is voor gebruik op een meergebruikerssysteem, waar je de library wil delen/gemeenschappelijk (dezelfde) gebruiken.
6. zoals 5., maar bij 6. gaat een gewoon gambas programma gebruikt worden als library (oudere manier).

Maken

Start de Gambas IDE, maak een nieuw project (New Project), “Project Type” helpt niet in je keuze; (ik neem het eerste, command line application), kies een directory en een naam. Ok.

Menu Project, Properties: hier kan je meer details ingeven in instellingen doen:
Project type: “Library”
Vul ook de “vendor” in, want die wordt ook gebruikt in de directorystruktuur. Zet er bv je eigen bedrijfsnaam of organisatienaam.

De klassen die je wil laten gebruiken (exposed) duid je aan met het sleutelwoord EXPORT.
Zij zullen zichtbaar zijn in het project dat de library gebruikt. Bv:

' Gambas class file
'
' uitleg van wat de klasse doet

Export
' hieronder de code v/d klasse


Onzichtbare klassen kunnen dienen voor testcode enz.

Als je zelf iets moet benaderen in de directorystruktuur: ./ is waar de library zelf staat, ../ zou verwijzen naar het hoofdproject.

Met Project, Make, Executable maak je het .gambas programma in een directory naar keuze op dat moment.
Daarbij wordt bv de testcode van Main gedraaid en kan je de debug output daarvan checken.

Dat maakt automatisch ook een uitvoerbaar programma van het library project in:
~/.local/share/gambas3/lib/vendorname/lib01:version.gambas

Je kan ze ook op niveau van het systeem installeren (zie boven “Locatie”)

Gebruiken

Het gebruikend project: open Project, Properties. Kies “Libaries” blad. Dan krijg je een venster met het “Runtime library search path”, en een lege lijn plus lege ruimte eronder.
Met “+ Add” knop voeg je er toe.

Je krijgt een venster “Select a Library”; ik zie in mijn geval een library staan in de directory waarin dit nieuwe project zit; selecteer, “ok”.

Zichtbaar in de lijst:

vendor > Lib01 0.0.1
Location: /home/naam/.local/share/gambas3/lib/vendor/Lib01:0.0.gambas
Provides: Class1, Class2

Je kan de library hier ook verwijderen, en van plaats veranderen in de lijst.

Meer libraries: dan moet je letten op de volgorde in deze lijst; die moet juist zijn.
(volgens documentatie: van bovenaan/eerste tot onderaan/laatste).

Gevorderd?
De documentatie houdt daar zowat op; niets over:

• Hierarchie van libaries
• Initialiseren van een library
• Versie-nummering *
• …

* Versienummer:
Als je in de library code Application.Version gebruikt in een procedure, en je roept die op vanuit een gebruikend programma, dan wordt die zo letterlijk uitgevoerd dat je de versie van je uitvoerend programma te zien krijgt, en niet die van de library.
Je kan het versienummer in een Version.txt bestandje in de Data directory van je library zetten, en de inhoud van die file terugsturen in plaats van Application.Version.
Beter nog, als je het bestand “VERSION” noemt, en in het project het vakje “Get from VERSION file” aanklikt, wordt dat ook automatisch gebruikt binnen je library programma zelf.

Update v.d. library
Hoe een library updaten?
TestLib is de library.
TestLib.gambas is de executable daarvan.

De file is ook terug te vinden als:
/home/username/.local/share/gambas3/lib/vendorname/TestLib:0.0.1.gambas

TestProgram op hetzelfde systeem is het programma dat deze lib gebruikt.

Wanneer krijgt TestProgram een “nieuwe versie” van TestLib in gebruik?

• TestLib code gewijzigd. Run TestLib. – Run TestProgram vanuit IDE. –> Nee
• TestLib code gewijzigd. Run TestLib. – Refresh TestProgram project vanuit IDE + Run –> Nee
• TestLib code gewijzigd. Make Executable. – Run TestProgram vanuit IDE. Ja!
  Ook: TestLib:0.0.1.gambas datum/tijd wordt aangepast;
• TestLib code gewijzigd. Make Executable. – Nog draaiend TestProgram vanuit IDE: –> Nee

De library wordt dus geladen bij het starten van het programma.

2) Componenten

Bron:
How To Program Components In Gambas (gambaswiki.org/wiki/dev/gambas)

Component
Gambas componenten zijn gedeelde bibliotheken die geschreven zijn in C, C++ of in Gambas zelf. Ze voegen nieuwe klassen toe aan de Gambas programmeeromgeving, en vormen een uitbreiding van de Gambas taal. Ze zijn voor algemeen gebruik bestemd, en worden dus verspreid met de gambas broncode.

Component maken

Project type: Component.

Je moet in de code EXPORTEER code gebruiken en de component voorzien van alles wat de IDE nodig heeft (eigenschappen met standaardwaarden, help enz).

—

Ook interessant: het object model van Gambas gambaswiki.org/wiki/doc/object-model

Bij deze gambas zit een printvoorbeeld, dat werkt met een Printer object dat op de Form geplaatst is
(Ik ga die in code te definiëren omdat ik een module gebruik en geen form)
In het printvoorbeeld is er één voor tekst: “prtText”, en één voor beeld “prtImage”.

Op de form geselecteerd zie je de eigenschappen:

Class: Printer
Name: prtText
Group :
CollateCopies: False
Duplex: Simplex
FullPage : False
GrayScale: False
Orientation: Portrait
Paper: A4
Public: False
ReverseOrder: False
X: 434
Y: 217

Op de FMain form zien we:

• TextAerea “txtText” (deze bevat de opgemaakte text met html codes zichtbaar)
• ScrollArea “scrText” (deze bevat de opgemaakte tekst met de opmaak in werking)

Net daarboven een ButtonBox “txtFontText” die de naam van de font bevat. Die wordt bij openen gevuld met een font “17”, en heeft een knop om een andere font te kiezen.

De tekst wordt klaargezet in op de form (eventueel geladen uit een bestand) in txtText en scrText.

Er zijn twee methoden voor prtText:

prtText_Begin()
en
prtText_Draw()

Het printen wordt gestart vanuit een button en dat aktiveert:

If prtText.Configure() Then Return
Inc Application.Busy
prtText.Print
Dec Application.Busy

De methodes Begin en Draw worden door het .Print commando automatisch aan geroepen, maar je moet ze dus wel zelf voorzien.

In de Draw methode geef je de tekst die geprint moet worden als één van de parameters.

—

Geprobeerd om de essentie even uit het printvoorbeeld van Gambas zelf te halen, met eigen variabele namen:

Form
FMain:
– bovenaan een listbox lsbxLog, een knop btPrint, en een printer object, dat ik “Printer1” noem.
– eronder een tabPanel1 met 4 tabs: Text from file, -from screen, image, drawing
– de TAB’s:
— from file: FileChooser1 en TextArea1
— from screen: FontChooser1 (en nog niet gebruikte ScrollAreaText)

Code

' Gambas class file
Public $fLeftMargin As Float = 10
Public $fStartLine As Float = 15
'
'
Public Sub Form_Open()
'
End
'
'
Public Sub FileChooser1_Change()
  '
  Try TextArea1.Text = File.Load(FileChooser1.Value)
  '
End
'
'
Public Sub btPrint_Click()
  '
  Dim bDone As Boolean
  '
  If Printer1.Configure() Then Return
  btPrint.Enabled = False
  Inc Application.Busy
  '
  bDone = Printer1.Print()
  '
  Dec Application.Busy
  btPrint.Enabled = True
  '
End
'
'
Public Sub Printer1_Begin()
 '  
End
'
'
Public Sub Printer1_Draw()
  '
  Select TabPanel1.Index
    Case 0
      lsbxLog.Add("from file", 0)
      printFromFile(FileChooser1.Value)
    Case 1
      lsbxLog.Add("from text", 0)
      printRichText(FileChooser1.Value)
    Case 2
      lsbxLog.Add("from image", 0)
    Case 3 
      lsbxLog.Add("from drawing", 0)
  End Select
  '
End
'
'
Public Sub Printer1_End()
  '
End
'
'
Public Sub printFromFile(sFileName As String)
  ' title = filename
  Paint.Font.Bold = True
  Paint.DrawText(sFileName, $fLeftMargin, $fStartLine, 700, 1400, Align.TopNormal)
  ' text
  Paint.Font.bold = False
  Paint.DrawText(File.Load(sFileName), $fLeftMargin, $fStartLine + 100, 700, 1400, Align.TopNormal)  ' this works but without further adjustments, the text in the lines runs from the page and is lost
  '
End
'
'
Public Sub printRichText(sFileName As String)
  '
  Dim myText As String
  '
  myText = "< H 3 >" & sFileName & "< / H 3 > " & gb.NewLine
  myText &= File.Load(sFileName)
  '
  Try Paint.Font = FontChooser1.Value
  '
  Paint.DrawRichText(myText, $fLeftMargin, $fStartLine, 9500, 1400, Align.TopNormal)
  '
End

nb:
De html codes een beetje uitgerokken om ze te kunnen zetten.
De juiste impact van de “width” bv 700 in eerste; geen?

In printRichText geeft 700 een smalle kolom, en 9500 een hele bladbreedte, maar dat hangt natuurlijk af van allerlei.

als ik tijd heb vul ik aan met de images/drawings