Utils::MacroExpander Class

Detaljan opis

Varijable

Nazivi varijabli mogu biti u osnovi bilo koji niz bez znaka dolara i zagrada, iako se preporučuje koristiti samo 7-bitni ASCII bez posebnih znakova i praznih znakova.

Ako postoji više varijabli koje sadrže različite aspekte istog objekta, uobičajeno je dati im isti prefiks, nakon kojeg slijedi dvotočja i sufiks koji opisuje aspekt. Primjeri toga su CurrentDocument:FilePath i CurrentDocument:Selection.

Kada se od upravitelja varijabli zatraži zamjena varijabli u nizu, on traži nazive varijabli okružene znakovima %{ i }, poput %{CurrentDocument:FilePath}.

Promjenjive okruženja dostupne su pomoću notacije %{Env:...}. Na primjer, za pristup promjenjivoj okruženja SHELL upotrijebite %{Env:SHELL}.

Postavljanje vrijednosti varijabli

Dodaci mogu registrirati varijable zajedno s opisom pomoću registerVariable(). Tipična konfiguracija je registrirati varijable u funkciji Plugin::initialize().

void MyPlugin::initialize()
{
    [...]
    MacroExpander::registerVariable(
        "MyVariable",
        Tr::tr("The current value of whatever I want."));
        [] {
            QString value;
            // do whatever is necessary to retrieve the value
            [...]
            return value;
        }
    );
    [...]
}

Za varijable koje se odnose na datoteku trebali biste koristiti praktičnu funkciju MacroExpander::registerFileVariables(). Funkcije prihvaćaju prefiks varijable, poput MyFileVariable, i automatski obrađuju standardizirane sufikse poput :FilePath, :Path i :FileBaseName, što rezultira kombiniranim varijablama, kao što je MyFileVariable:FilePath.

Pružanje i proširivanje parametriziranih nizova

Iako je moguće jednostavno zatražiti od upravitelja varijabli vrijednost neke varijable u vašem kodu, poželjniji je slučaj upotrebe pružiti korisniku mogućnost parametrizacije nizova, na primjer za postavke.

(Ako ikada razmišljate o prvom pristupu, razmislite dvaput. Mnogo je učinkovitije jednostavno izravno pitati dodatak koji pruža vrijednost varijable, bez pretvaranja nizova i korištenja upravitelja varijablama koji će izvršiti opsežno ispitivanje. Da budemo konkretniji, koristeći primjer iz odjeljka "Providing Variable Values": umjesto pozivanja MacroExpander::value("MyVariable"), puno je učinkovitije jednostavno izravno pitati pomoću MyPlugin::variableValue().)

Korisničko sučelje

Ako je niz koji želite parametrizirati postavljiv od strane korisnika, putem klase naslijeđene od QLineEdit ili QTextEdit, trebali biste dodati odabirač varijabli u svoj korisnički sučelje, koji omogućuje dodavanje varijabli nizu pregledavanjem popisa. Za više detalja pogledajte Utils::VariableChooser.

Proširivanje nizova

Proširivanje vrijednosti varijabli u nizovima vrše "macro expanders". Utils::AbstractMacroExpander je temeljna klasa za njih, a upravitelj varijablama pruža implementaciju koja proširuje varijable Qt Creator putem MacroExpander::macroExpander().

Postoji nekoliko različitih načina za proširenje niza, koji pokrivaju različite slučajeve upotrebe, a ovdje su navedeni poredani prema relevantnosti:

• Korištenje MacroExpander::expandedString(). Ovo je najpraktičniji način za dobivanje niza s proširenim vrijednostima varijabli, ali i najmanje fleksibilan. Ako vam to odgovara, koristite ga.
• Korištenje funkcija Utils::expandMacros(). One uzimaju niz i makro ekspandor (za koji biste koristili onaj koji pruža upravitelj varijabli). Uglavnom su iste kao MacroExpander::expandedString(), ali imaju i varijantu koja vrši zamjenu inlinu umjesto da vraća novi niz.
• Korištenje funkcije Utils::CommandLine::expandMacros(). Ona proširuje niz poštujući pravila citiranja platforme na kojoj se izvršava. Koristite ovu funkciju s proširivačem makronaredbi upravitelja varijabli ako će se vaš niz proslijediti kao niz parametara naredbenog retka vanjskoj naredbi.
• Napisati vlastiti makro-ekspander koji unutar sebe poziva makro-ekspander upravitelja varijabli. A zatim izvršiti jednu od navedenih radnji. To vam omogućuje proširivanje dodatnih "lokalnih" varijabli/makronaredbi koje ne dolaze od upravitelja varijabli.