ScriptForge.TextStream zerbitzua

TextStream zerbitzua ScriptForge.FileSystem zerbitzuaren bidez ireki edo sortu diren fitxategiak sekuentzialki irakurtzeko edo idazteko erabiltzen da.

FileSystem zerbitzuaren OpenTextFile eta CreateTextFile metodoek TextStream zerbitzuaren instantzia bat itzultzen dute.

Erabiltzaileak lerro-mugatzaileak zehaztu ditzakte. Sarrerako eragiketetan, CR, LF edo CR+LF onartzen dira. Irteerako eragiketetan, sistema eragileak erabiltzen duen lerro-mugatzailea erabiliko da modu lehenetsian.

Makroa exekutatzen ari den sistema eragilearen lerro-mugatzailea atzitzeko, erabili SF_String.sfNEWLINE propietatea.

Fitxategi bat irakurtzeko edo idazteko behar diren eragiketa guztiak (ireki, irakurri/idatzi eta itxi) makroa exekutatzen den unean gertatzen direla suposatzen da.

Zerbitzuari deitzea

Beheko kode-zatiak, Basi eta Python lengoaietan, OpenTextFile metodoa darabil TextStream zerbitzuaren instantzia bat sortzeko.

GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Dim FSO As Variant
FSO = CreateScriptService("FileSystem")
Set myFile = FSO.OpenTextFile("C:\Temp\ThisFile.txt", FSO.ForReading)

Fitxategia itxi egin behar da, CloseFile metodoa erabilita, irakurtzeko edo idazteko eragiketa guztiak exekutatu ondoren:

myFile.CloseFile()

Aukeran, TextStream instantziak erabilitako baliabideak askatu egin daitezke Dispose metodoaren bidez:

Set myFile = myFile.Dispose()

TextStream zerbitzuko metodoak XTextInputStream eta XTextOutputStream UNO interfazeetan daude oinarrituta gehien bat.

from scriptforge import CreateScriptService
fs = CreateScriptService("FileSystem")
myFile = fs.OpenTextFile(r"C:\Temp\ThisFile.txt", fs.ForReading)
# ...
myFile.CloseFile()
myFile = myFile.Dispose()

Propietateak

Karaktere jokoen izenei buruz gehiago jakiteko, begiratu IANAren karaktere jokoen orria. Kontuan izan Collabora Office aplikazioak ez dituela karaktere joko guztiak inplementatu.

CloseFile

Uneko sarrerako edo irteerako korrontea ixten du eta irteerako bufferra husten du, beharrezkoa bada. True itzuliko du fitxategia ongi itxi bada.

myFile.CloseFile(): bool

ReadAll

Testu-korrontean geratzen diren lerro guztiak kate bakar gisa itzultzen ditu. Lerro-jauziak ez dira kenduko.

Emaitza gisa lortutako katea lerroetan zatitu daiteke, bai integratutako Split Basic funtzioaren bidez lerro-mugatzailea ezaguna bada, bai SF_String.SplitLines metodoaren bidez.

Fitxategi handien kasuan, ReadAll metodoa erabiltzen bada memoria-baliabideak alferrik galtzen dira. Kasu horietan, hobe da fitxategia lerroz lerro irakurtzea ReadLine metodoaren bidez.

myFile.ReadAll(): str

Adibidez, demagun "Students.txt" fitxategiak honako edukiak dituela (izen bana lerro bakoitzean):

Herbie Peggy
Hardy Jarrett
Edith Lorelle
Roderick Rosamund
Placid Everette

Beheko adibideak, Basic eta Python lengoaietan, ReadAll eta SplitLines metodoak erabiltzen ditu fitxategi baten edukiak irakurri eta kateen matrize batean jartzeko:

' FileSystem zerbitzua kargatzen du
Dim FSO : FSO = CreateScriptService("FileSystem")
' Irakurri behar diren izenak dituen testu-fitxategia irekitzen du
Dim inputFile as Object
Set inputFile = FSO.OpenTextFile("/home/user/Documents/Students.txt")
'Sarrerako fitxategiko eduki guztiak kate bakar gisa irakurtzen ditu
Dim allData as String
allData = inputFile.ReadAll()
'Katea matrize batean zatitzen du
Dim arrNames as Variant
arrNames = SF_String.SplitLines(allData)
' (...)
inputFile.CloseFile()

fs = CreateScriptService("FileSystem")
inputFile = fs.OpenTextFile("/home/user/Documents/Students.txt")
allData = inputFile.ReadAll()
arrNames = allData.split(inputFile.NewLine)
# ...
inputFile.CloseFile()

ReadLine

Hurrengo lerroa itzultzen du testu-korrontea kate bat bada. Lerro-jauziak ezabatu egingo dira itzulitako fitxategitik.

AtEndOfStream probak ReadLine metodoaren aurretik egon behar du, beheko adibidean bezala.

Errore bat sortuko da AtEndOfStream iristen bada aurreko ReadLine edo SkipLine metodoari deitu baino lehen.

myFile.ReadLine(): str

Dim sLine As String
Do While Not myFile.AtEndOfStream
    sLine = myFile.ReadLine()
    ' (...)
Loop

while not myFile.AtEndOfStream:
    sLine = myFile.ReadLine()
    # ...

SkipLine

Sarrera-korronteko hurrengo lerroa saltatzen du TextStream fitxategi bat irakurtzean.

Metodo honen emaitza izan daiteke AtEndOfStream propietatean True ezartzea.

myFile.SkipLine()

WriteBlankLines

Lerro hutsen kopuru zehatz bat idazten du irteera-korrontean.

myFile.WriteBlankLines(lines: int)

lines: Idatziko den lerro hutsen kopurua.

WriteLine

Emandako katea irteera-korrontean idazten du lerro bakar gisa.

NewLine propietatean definitutako karakterea lerro-mugatzaile gisa erabiliko da.

myFile.WriteLine(line: str)

line: Idatziko den lerroa, hutsik egon daiteke.

Beheko adibideetan, Basic eta Python lengoaietan, testu-fitxategi bat sortzen da CSV formatuan, non lerro bakoitzak balio bat eta bere karratua dituen, lastValue baliora iritsi arte.

Sub SquaredValuesFile(lastValue as Integer)
    'FileSystem zerbitzuaren instantzia bat sortzen du
    Dim FSO as Variant : FSO = CreateScriptService("FileSystem")
    'Testu-fitxategi bat sortzen du
    Dim myFile as Variant : myFile = FSO.CreateTextFile("/home/user/Documents/squares.csv")
    ' 'Balioa' eta 'Balio karratua' balioak idazten ditu, ";" ikurrarekin bananduta
    Dim value as Integer
    myFile.WriteLine("Balioa;Balio karratua")
    For value = 1 To lastValue
        myFile.WriteLine(value & ";" & value ^ 2)
    Next value
    'Fitxategia ixten du eta baliabideak askatzen ditu
    myFile.CloseFile()
    Set myFile = myFile.Dispose()
End Sub

def squared_values_file(lastValue):
    fs = CreateScriptService("FileSystem")
    myFile = fs.CreateTextFile("/home/user/Documents/squares.csv")
    myFile.WriteLine("Value;Value Squared")
    for value in range(1, lastValue + 1):
        myFile.WriteLine("{};{}".format(value, value ** 2))
    myFile.CloseFile()
    myFile = myFile.Dispose()

Azpimarraren karaktere bat, "_", aurrizki gisa duten ScriptForge Basic errutina edo identifikatzaile guztiak barneko erabilerarako erreserbatuta daude. Ez dira Basic makroetan edo Python scriptetan erabili behar.