# HG changeset patch # User František Kučera # Date 1326037950 -3600 # Node ID c7746d95283dd6e6ada0795715c263037b754df1 # Parent dbf6e5dbeecda6c278181c2a97ea0b64a23fad6d Rozdělení knihovny funkcí podle maker, ve kterých se funkce používají. #8 diff -r dbf6e5dbeecd -r c7746d95283d šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java --- a/šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java Sun Jan 08 11:36:36 2012 +0100 +++ b/šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java Sun Jan 08 16:52:30 2012 +0100 @@ -18,33 +18,17 @@ package cz.frantovo.xmlWebGenerator; import java.io.File; -import java.io.IOException; -import java.io.PrintStream; import java.util.Date; import java.net.URI; import java.net.URISyntaxException; -import java.net.URLDecoder; -import java.nio.charset.Charset; -import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*; /** - * Knihovna funkcí volaných z XSLT. + * Společná knihovna funkcí volaných z XSLT * - * TODO: - * - rozdělit na více modulů (jmenných prostorů). - * - CLI konektor - * - * @author fiki + * @author František Kučera (frantovo.cz) */ public class Funkce { - - private static final String PŘÍKAZ_PYGMENTIZE = "pygmentize"; - private static final String PŘÍKAZ_DOT = "dot"; - private static final String PŘÍKAZ_MARKDOWN = "markdown"; - private static final String ADRESÁŘ_VÝSTUPNÍ = "výstup"; - private static int počítadloDiagramů = 0; - private static String počítadloDiagramůKontext = ""; // aktuálně zpracovávaná stránka, při změně vynulujeme počítadlo - + /** * Zjištuje, kdy byl naposledy daný soubor změněn. * @param soubor cesta k souboru @@ -56,178 +40,4 @@ File f = new File(uri); return new Date(f.lastModified()); } - - /** - * Zvýrazňuje syntaxi zdrojového kódu. Používá k tomu externí program/knihovnu pygmentize. - * @param zdroják zdrojový kód, který předáme příkazu pygmentize na standardním vstupu - * @param jazyk předáme příkazu pygmentize jako parametr -l <lexer> - * @return zvýrazněný text nebo null, pokud došlo k chybě. - * TODO: - * - vracet místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html - * - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost pygmentize) - */ - public static String zvýrazniSyntaxi(String zdroják, String jazyk) throws IOException, InterruptedException { - if (jazyk == null || jazyk.length() == 0) { - System.err.println("Není vyplněn atribut „jazyk“ → není jasné, jak se má zvýrazňovat."); - return null; - } else if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) { - Runtime r = Runtime.getRuntime(); - Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-f", "html", "-l", jazyk}); - - PrintStream vstupProcesu = new PrintStream(p.getOutputStream()); - vstupProcesu.print(zdroják); - vstupProcesu.close(); - - String výsledek = načtiProud(p.getInputStream()); - String chyby = načtiProud(p.getErrorStream()); - - p.waitFor(); - - if (chyby.length() == 0) { - // Pozor: pygmentize má i při chybě návratový kód 0 → je potřeba kontrolovat chybový výstup. - return výsledek; - } else { - System.err.print("Při zvýrazňování syntaxe došlo k chybě: " + chyby); - return null; - } - } else { - System.err.println("Příkaz " + PŘÍKAZ_PYGMENTIZE + " není na vašem systému dostupný → zvýrazňování syntaxe nebude fungovat."); - System.err.println("Můžete ho nainstalovat pomocí:"); - System.err.println("\t$ aptitude install python-pygments # (Debian/Ubuntu)"); - System.err.println("\t$ yum install python-pygments # (Fedora/RedHat)"); - return null; - } - } - - /** - * Vygeneruje CSS styl pro zvýrazňování syntaxe. - * @return obsah CSS souboru nebo null, pokud generování nebylo možné - */ - public static String generujCssSyntaxe() throws IOException, InterruptedException { - if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) { - Runtime r = Runtime.getRuntime(); - Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"}); - return načtiProud(p.getInputStream()); - } else { - return null; - } - } - - /** - * Vytvoří obrázek s diagramem. - * @param zadání definice diagramu ve formátu dot - * @param vodorovně zda má být graf orientovaný vodorovně (funguje jen při kompletní = false) - * @param kompletní false, pokud k zadání chceme doplnit digraph d {…} - * @param kontext kam diagram patří – typicky název stránky, do které je vložen - * diagramy se pak budou číslovat v rámci tohoto kontextu - * → nebude docházet k přepisování diagramů jiných stránek při částečném přegenerování webu. - * @param souborZadání null pokud chceme automatické číslování | nebo zadáme název souboru se zadáním diagramu – vygenerovaný diagram se pak bude jmenovat stejně - * @return název souboru bez přípony, který byl vytvořen, nebo null, pokud došlo k chybě. - */ - public static String vytvořDiagram(String zadání, boolean vodorovně, boolean kompletní, String kontext, String souborZadání) throws IOException, InterruptedException { - if (isPříkazDostupný(PŘÍKAZ_DOT)) { - - String soubor; - if (souborZadání == null) { - if (kontext == null) { - počítadloDiagramů++; - soubor = "diagram-" + počítadloDiagramů; - } else { - // TODO: tohle by se mělo udělat v XSLT - kontext = URLDecoder.decode(kontext, Charset.defaultCharset().name()); - - // Každá stránka bude mít svoje diagramy číslované od 1 - if (!počítadloDiagramůKontext.equals(kontext)) { - počítadloDiagramůKontext = kontext; - počítadloDiagramů = 0; - } - - počítadloDiagramů++; - soubor = "diagram-" + kontext + "-" + počítadloDiagramů; - } - } else { - soubor = souborZadání; - } - String souborSložka = ADRESÁŘ_VÝSTUPNÍ + File.separator + soubor; - - String zdroják; - if (kompletní) { - zdroják = zadání; - } else { - StringBuilder b = new StringBuilder(zadání.length() + 200); - b.append("digraph d {\n"); - b.append("\tbgcolor=\"transparent\";\n"); - if (vodorovně) { - b.append("\trankdir=LR;"); - } - b.append(zadání); - b.append("}\n"); - zdroják = b.toString(); - } - - Runtime r = Runtime.getRuntime(); - Process p = r.exec(new String[]{PŘÍKAZ_DOT, "-T", "svg", "-o", souborSložka + ".svg"}); - - /** - * TODO: generovat i PNG bitmapu - */ - PrintStream vstupProcesu = new PrintStream(p.getOutputStream()); - vstupProcesu.print(zdroják.toString()); - vstupProcesu.close(); - - String chyby = načtiProud(p.getErrorStream()); - - p.waitFor(); - - if (chyby.length() == 0) { - return soubor; - } else { - System.err.print("Při vytváření diagramu došlo k chybě: " + chyby); - return null; - } - } else { - System.err.println("Příkaz " + PŘÍKAZ_DOT + " není na vašem systému dostupný → diagramy nelze vygreslit."); - System.err.println("Můžete ho nainstalovat pomocí:"); - System.err.println("\t$ aptitude install graphviz # (Debian/Ubuntu)"); - System.err.println("\t$ yum install graphviz # (Fedora/RedHat)"); - return null; - } - } - - /** - * Převede text ve wiki syntaxi do XHTML. - * @param wiki vstupní text v dané wiki syntaxi - * @param syntaxe null nebo volitelně syntaxe (markdown, texy) - * @return naformátované XHTML - */ - public static String formátujWiki(String wiki, String syntaxe) throws IOException { - if (isPříkazDostupný(PŘÍKAZ_MARKDOWN)) { - Runtime r = Runtime.getRuntime(); - Process p = r.exec(new String[]{PŘÍKAZ_MARKDOWN}); - - /** - * TODO: oříznout mezery na začátcích řádků, pokud je jich všude stejně? - * (odsazení v XML) - */ - PrintStream vstupProcesu = new PrintStream(p.getOutputStream()); - vstupProcesu.print(wiki); - vstupProcesu.close(); - - String chyby = načtiProud(p.getErrorStream()); - String xhtml = načtiProud(p.getInputStream()); - - if (chyby.length() == 0) { - return xhtml; - } else { - System.err.print("Při zpracování wiki syntaxe došlo k chybě: " + chyby); - return null; - } - } else { - System.err.println("Příkaz " + PŘÍKAZ_MARKDOWN + " není na vašem systému dostupný → nelze formátovat texty ve wiki syntaxi."); - System.err.println("Můžete ho nainstalovat pomocí:"); - System.err.println("\t$ aptitude install markdown # (Debian/Ubuntu)"); - System.err.println("\t$ yum install perl-Text-Markdown # (Fedora/RedHat)"); - return null; - } - } } diff -r dbf6e5dbeecd -r c7746d95283d šablona/funkce/src/cz/frantovo/xmlWebGenerator/NástrojeCLI.java --- a/šablona/funkce/src/cz/frantovo/xmlWebGenerator/NástrojeCLI.java Sun Jan 08 11:36:36 2012 +0100 +++ b/šablona/funkce/src/cz/frantovo/xmlWebGenerator/NástrojeCLI.java Sun Jan 08 16:52:30 2012 +0100 @@ -24,7 +24,10 @@ /** * Pomocné funkce pro práci s příkazy - * @author fiki + * + * Tyto funkce nejsou určené k přímému volání z XSLT. + * + * @author František Kučera (frantovo.cz) */ public class NástrojeCLI { diff -r dbf6e5dbeecd -r c7746d95283d šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Diagram.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Diagram.java Sun Jan 08 16:52:30 2012 +0100 @@ -0,0 +1,119 @@ +/** + * XML Web generátor – program na generování webových stránek + * Copyright © 2012 František Kučera (frantovo.cz) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package cz.frantovo.xmlWebGenerator.makra; + +import java.io.File; +import java.io.IOException; +import java.io.PrintStream; +import java.net.URLDecoder; +import java.nio.charset.Charset; +import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*; + +/** + * Diagramy + * + * @author František Kučera (frantovo.cz) + */ +public class Diagram { + + private static final String ADRESÁŘ_VÝSTUPNÍ = "výstup"; + private static final String PŘÍKAZ_DOT = "dot"; + private static int počítadloDiagramů = 0; + private static String počítadloDiagramůKontext = ""; // aktuálně zpracovávaná stránka, při změně vynulujeme počítadlo + + /** + * Vytvoří obrázek s diagramem. + * @param zadání definice diagramu ve formátu dot + * @param vodorovně zda má být graf orientovaný vodorovně (funguje jen při kompletní = false) + * @param kompletní false, pokud k zadání chceme doplnit digraph d {…} + * @param kontext kam diagram patří – typicky název stránky, do které je vložen + * diagramy se pak budou číslovat v rámci tohoto kontextu + * → nebude docházet k přepisování diagramů jiných stránek při částečném přegenerování webu. + * @param souborZadání null pokud chceme automatické číslování | nebo zadáme název souboru se zadáním diagramu – vygenerovaný diagram se pak bude jmenovat stejně + * @return název souboru bez přípony, který byl vytvořen, nebo null, pokud došlo k chybě. + */ + public static String vytvořDiagram(String zadání, boolean vodorovně, boolean kompletní, String kontext, String souborZadání) throws IOException, InterruptedException { + if (isPříkazDostupný(PŘÍKAZ_DOT)) { + + String soubor; + if (souborZadání == null) { + if (kontext == null) { + počítadloDiagramů++; + soubor = "diagram-" + počítadloDiagramů; + } else { + // TODO: tohle by se mělo udělat v XSLT + kontext = URLDecoder.decode(kontext, Charset.defaultCharset().name()); + + // Každá stránka bude mít svoje diagramy číslované od 1 + if (!počítadloDiagramůKontext.equals(kontext)) { + počítadloDiagramůKontext = kontext; + počítadloDiagramů = 0; + } + + počítadloDiagramů++; + soubor = "diagram-" + kontext + "-" + počítadloDiagramů; + } + } else { + soubor = souborZadání; + } + String souborSložka = ADRESÁŘ_VÝSTUPNÍ + File.separator + soubor; + + String zdroják; + if (kompletní) { + zdroják = zadání; + } else { + StringBuilder b = new StringBuilder(zadání.length() + 200); + b.append("digraph d {\n"); + b.append("\tbgcolor=\"transparent\";\n"); + if (vodorovně) { + b.append("\trankdir=LR;"); + } + b.append(zadání); + b.append("}\n"); + zdroják = b.toString(); + } + + Runtime r = Runtime.getRuntime(); + Process p = r.exec(new String[]{PŘÍKAZ_DOT, "-T", "svg", "-o", souborSložka + ".svg"}); + + /** + * TODO: generovat i PNG bitmapu + */ + PrintStream vstupProcesu = new PrintStream(p.getOutputStream()); + vstupProcesu.print(zdroják.toString()); + vstupProcesu.close(); + + String chyby = načtiProud(p.getErrorStream()); + + p.waitFor(); + + if (chyby.length() == 0) { + return soubor; + } else { + System.err.print("Při vytváření diagramu došlo k chybě: " + chyby); + return null; + } + } else { + System.err.println("Příkaz " + PŘÍKAZ_DOT + " není na vašem systému dostupný → diagramy nelze vygreslit."); + System.err.println("Můžete ho nainstalovat pomocí:"); + System.err.println("\t$ aptitude install graphviz # (Debian/Ubuntu)"); + System.err.println("\t$ yum install graphviz # (Fedora/RedHat)"); + return null; + } + } +} diff -r dbf6e5dbeecd -r c7746d95283d šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Pre.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Pre.java Sun Jan 08 16:52:30 2012 +0100 @@ -0,0 +1,88 @@ +/** + * XML Web generátor – program na generování webových stránek + * Copyright © 2012 František Kučera (frantovo.cz) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package cz.frantovo.xmlWebGenerator.makra; + +import java.io.IOException; +import java.io.PrintStream; +import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*; + +/** + * Zvýrazňování syntaxe + * + * @author František Kučera (frantovo.cz) + */ +public class Pre { + + private static final String PŘÍKAZ_PYGMENTIZE = "pygmentize"; + + /** + * Zvýrazňuje syntaxi zdrojového kódu. Používá k tomu externí program/knihovnu pygmentize. + * @param zdroják zdrojový kód, který předáme příkazu pygmentize na standardním vstupu + * @param jazyk předáme příkazu pygmentize jako parametr -l <lexer> + * @return zvýrazněný text nebo null, pokud došlo k chybě. + * TODO: + * - vracet místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html + * - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost pygmentize) + */ + public static String zvýrazniSyntaxi(String zdroják, String jazyk) throws IOException, InterruptedException { + if (jazyk == null || jazyk.length() == 0) { + System.err.println("Není vyplněn atribut „jazyk“ → není jasné, jak se má zvýrazňovat."); + return null; + } else if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) { + Runtime r = Runtime.getRuntime(); + Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-f", "html", "-l", jazyk}); + + PrintStream vstupProcesu = new PrintStream(p.getOutputStream()); + vstupProcesu.print(zdroják); + vstupProcesu.close(); + + String výsledek = načtiProud(p.getInputStream()); + String chyby = načtiProud(p.getErrorStream()); + + p.waitFor(); + + if (chyby.length() == 0) { + // Pozor: pygmentize má i při chybě návratový kód 0 → je potřeba kontrolovat chybový výstup. + return výsledek; + } else { + System.err.print("Při zvýrazňování syntaxe došlo k chybě: " + chyby); + return null; + } + } else { + System.err.println("Příkaz " + PŘÍKAZ_PYGMENTIZE + " není na vašem systému dostupný → zvýrazňování syntaxe nebude fungovat."); + System.err.println("Můžete ho nainstalovat pomocí:"); + System.err.println("\t$ aptitude install python-pygments # (Debian/Ubuntu)"); + System.err.println("\t$ yum install python-pygments # (Fedora/RedHat)"); + return null; + } + } + + /** + * Vygeneruje CSS styl pro zvýrazňování syntaxe. + * @return obsah CSS souboru nebo null, pokud generování nebylo možné + */ + public static String generujCssSyntaxe() throws IOException, InterruptedException { + if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) { + Runtime r = Runtime.getRuntime(); + Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"}); + return načtiProud(p.getInputStream()); + } else { + return null; + } + } +} diff -r dbf6e5dbeecd -r c7746d95283d šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Wiki.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Wiki.java Sun Jan 08 16:52:30 2012 +0100 @@ -0,0 +1,73 @@ +/** + * XML Web generátor – program na generování webových stránek + * Copyright © 2012 František Kučera (frantovo.cz) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package cz.frantovo.xmlWebGenerator.makra; + +import java.io.IOException; +import java.io.PrintStream; +import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*; + +/** + * Wiki syntaxe + * + * @author František Kučera (frantovo.cz) + */ +public class Wiki { + + private static final String PŘÍKAZ_MARKDOWN = "markdown"; + + /** + * Převede text ve wiki syntaxi do XHTML. + * @param wiki vstupní text v dané wiki syntaxi + * @param syntaxe null nebo volitelně syntaxe (markdown, texy) + * @return naformátované XHTML + * TODO: + * - vracet místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html + * - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost markdownu) + + */ + public static String formátujWiki(String wiki, String syntaxe) throws IOException { + if (isPříkazDostupný(PŘÍKAZ_MARKDOWN)) { + Runtime r = Runtime.getRuntime(); + Process p = r.exec(new String[]{PŘÍKAZ_MARKDOWN}); + + /** + * TODO: oříznout mezery na začátcích řádků, pokud je jich všude stejně? + * (odsazení v XML) + */ + PrintStream vstupProcesu = new PrintStream(p.getOutputStream()); + vstupProcesu.print(wiki); + vstupProcesu.close(); + + String chyby = načtiProud(p.getErrorStream()); + String xhtml = načtiProud(p.getInputStream()); + + if (chyby.length() == 0) { + return xhtml; + } else { + System.err.print("Při zpracování wiki syntaxe došlo k chybě: " + chyby); + return null; + } + } else { + System.err.println("Příkaz " + PŘÍKAZ_MARKDOWN + " není na vašem systému dostupný → nelze formátovat texty ve wiki syntaxi."); + System.err.println("Můžete ho nainstalovat pomocí:"); + System.err.println("\t$ aptitude install markdown # (Debian/Ubuntu)"); + System.err.println("\t$ yum install perl-Text-Markdown # (Fedora/RedHat)"); + return null; + } + } +} diff -r dbf6e5dbeecd -r c7746d95283d šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/package-info.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/package-info.java Sun Jan 08 16:52:30 2012 +0100 @@ -0,0 +1,6 @@ +/* + * Podpůrné funkce pro jednotlivá makra (pokud to potřebují). + * Java je tu většinou pouze v roli lepidla, které zajistí napojení XSLT na jiné programy. + * Třída se jmenuje stejně jako makro. + */ +package cz.frantovo.xmlWebGenerator.makra; diff -r dbf6e5dbeecd -r c7746d95283d šablona/makra/diagramy.xsl --- a/šablona/makra/diagramy.xsl Sun Jan 08 11:36:36 2012 +0100 +++ b/šablona/makra/diagramy.xsl Sun Jan 08 16:52:30 2012 +0100 @@ -19,7 +19,7 @@ diff -r dbf6e5dbeecd -r c7746d95283d šablona/makra/wiki.xsl --- a/šablona/makra/wiki.xsl Sun Jan 08 11:36:36 2012 +0100 +++ b/šablona/makra/wiki.xsl Sun Jan 08 16:52:30 2012 +0100 @@ -19,7 +19,7 @@ diff -r dbf6e5dbeecd -r c7746d95283d šablona/makra/zvýraznění-syntaxe.xsl --- a/šablona/makra/zvýraznění-syntaxe.xsl Sun Jan 08 11:36:36 2012 +0100 +++ b/šablona/makra/zvýraznění-syntaxe.xsl Sun Jan 08 16:52:30 2012 +0100 @@ -19,7 +19,7 @@ diff -r dbf6e5dbeecd -r c7746d95283d šablona/syntaxe.xsl --- a/šablona/syntaxe.xsl Sun Jan 08 11:36:36 2012 +0100 +++ b/šablona/syntaxe.xsl Sun Jan 08 16:52:30 2012 +0100 @@ -18,7 +18,7 @@ -->