diff options
Diffstat (limited to 'libX11/specs/i18n/compose')
| -rw-r--r-- | libX11/specs/i18n/compose/Makefile.am | 20 | ||||
| -rw-r--r-- | libX11/specs/i18n/compose/compose-chart.pl | 388 | ||||
| -rw-r--r-- | libX11/specs/i18n/compose/docbook-nl.am | 128 |
3 files changed, 536 insertions, 0 deletions
diff --git a/libX11/specs/i18n/compose/Makefile.am b/libX11/specs/i18n/compose/Makefile.am new file mode 100644 index 000000000..9e3a26dea --- /dev/null +++ b/libX11/specs/i18n/compose/Makefile.am @@ -0,0 +1,20 @@ +if ENABLE_SPECS +if HAVE_PERL + +# Main DocBook/XML files (DOCTYPE book) +docbook = libX11-keys.xml + +# Included chapters, appendix, images +chapters = $(locales:%=%.xml) + +# The location where the DocBook/XML generated formats are installed +shelfdir = $(docdir)/i18n/compose + +# Generate DocBook/XML output formats with or without stylesheets +# The XML source is generated and cleaned but not distributed +include docbook-nl.am + +endif HAVE_PERL +endif ENABLE_SPECS + +EXTRA_DIST = compose-chart.pl diff --git a/libX11/specs/i18n/compose/compose-chart.pl b/libX11/specs/i18n/compose/compose-chart.pl new file mode 100644 index 000000000..e2ac8509f --- /dev/null +++ b/libX11/specs/i18n/compose/compose-chart.pl @@ -0,0 +1,388 @@ +#! /usr/bin/perl +# +# Copyright 2009, 2010, Oracle and/or its affiliates. All rights reserved. +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice (including the next +# paragraph) shall be included in all copies or substantial portions of the +# Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +# DEALINGS IN THE SOFTWARE. +# + +# +# Make a DocBook chart showing compose combinations for a locale +# +# See perldoc at end (or run with --help or --man options) for details +# of command-line options. +# + +# Compose file grammar is defined in modules/im/ximcp/imLcPrs.c + +use strict; +use warnings; +use Getopt::Long; +use Pod::Usage; + +my $error_count = 0; + +my $charset; +my $locale_name; +my $output_filename = '-'; +my $man = 0; +my $help = 0; +my $make_index = 0; + +GetOptions ('charset:s' => \$charset, + 'locale=s' => \$locale_name, + 'output=s' => \$output_filename, + 'index' => \$make_index, + 'help|?' => \$help, + 'man' => \$man) + or pod2usage(2); +pod2usage(1) if $help; +pod2usage(-exitstatus => 0, -verbose => 2) if $man; + +if (!defined($charset) || ($charset eq "")) { + if (defined($locale_name)) { + my $guessed_charset = $locale_name; + $guessed_charset =~ s{^.*\.}{}; + if ($guessed_charset =~ m{^(utf-8|gbk|gb18030)$}i) { + $charset = $1; + } elsif ($guessed_charset =~ m{iso8859-(\d+)}i) { + $charset = "iso-8859-$1"; + } elsif ($guessed_charset =~ m{^microsoft-cp(125\d)$}) { + $charset = "windows-$1"; + } + } + if (!defined($charset) || ($charset eq "")) { + $charset = "utf-8"; + } +} + +if ($make_index) { + # Print Docbook output + open my $OUTPUT, '>', $output_filename + or die "Could not create $output_filename: $!"; + + print $OUTPUT + join ("\n", + qq(<?xml version="1.0" encoding="$charset" ?>), + q(<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"), + q( "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">), + q(<article id="libX11-keys">), + q( <articleinfo>), + q( <title>Xlib Compose Key Charts</title>), + q( </articleinfo>), + ( map { qq( <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="$_.xml">\ + <xi:fallback><section><title>$_</title><para></para></section></xi:fallback>\ + </xi:include>) } + @ARGV ), + q(</article>), + "\n" + ); + + close $OUTPUT or die "Couldn't write $output_filename: $!"; + + exit(0); +} + +foreach my $a (@ARGV) { + $error_count += make_compose_chart($a); +} + +exit($error_count); + +sub make_compose_chart { + my ($filename) = @_; + my $errors = 0; + + my @compose_table = (); + my @included_files = (); + + my $line = 0; + my $pre_file = ($filename =~ m{\.pre$}) ? 1 : 0; + my $in_c_comment = 0; + my $in_comment = 0; + my $keyseq_count = 0; + + open my $COMPOSE, '<', $filename or die "Could not open $filename: $!"; + + COMPOSE_LINE: + while (my $cl = <$COMPOSE>) { + $line++; + chomp($cl); + my $original_line = $cl; + + # Special handling for changes cpp makes to .pre files + if ($pre_file == 1) { + if ($in_c_comment) { # Look for end of multi-line C comment + if ($cl =~ m{\*/(.*)$}) { + $cl = $1; + $in_c_comment = 0; + } else { + next; + } + } + $cl =~ s{/\*.\**/}{}; # Remove single line C comments + if ($cl =~ m{^(.*)/\*}) { # Start of a multi-line C comment + $cl = $1; + $in_c_comment = 1; + } + $cl =~ s{^\s*XCOMM}{#}; # Translate pre-processing comments + } + + chomp($cl); + + if ($cl =~ m{^\s*#\s*(.*)$}) { # Comment only lines + # Combine commment blocks + my $comment = $1; + + if ($in_comment) { + my $prev_comment = pop @compose_table; + $comment = join(' ', $prev_comment->{-comment}, $comment); + } else { + $in_comment = 1; + } + + push @compose_table, { -type => 'comment', -comment => $comment }; + next COMPOSE_LINE; + } + + $in_comment = 0; + + if ($cl =~ m{^\s*$}) { # Skip blank lines + next COMPOSE_LINE; + } + elsif ($cl =~ m{^(STATE\s+|END_STATE)}) { + # Sun extension to compose file syntax + next COMPOSE_LINE; + } + elsif ($cl =~ m{^([^:]+)\s*:\s*(.+)$}) { + my ($seq, $action) = ($1, $2); + $seq =~ s{\s+$}{}; + + my @keys = grep { $_ !~ m/^\s*$/ } split /[\s\<\>]+/, $seq; + + push @compose_table, { + -type => 'keyseq', + -keys => [ @keys ], + -action => $action + }; + $keyseq_count++; + next COMPOSE_LINE; + } elsif ($cl =~ m{^(STATE_TYPE:|\@StartDeadKeyMap|\@EndDeadKeyMap)}) { + # ignore + next COMPOSE_LINE; + } elsif ($cl =~ m{^include "(.*)"}) { + my $incpath = $1; + $incpath =~ s{^X11_LOCALEDATADIR/(.*)/Compose}{the $1 compose table}; + + push @included_files, $incpath; + next COMPOSE_LINE; + } else { + print STDERR ('Unrecognized pattern in ', $filename, + ' on line #', $line, ":\n ", $cl, "\n"); + } + } + close $COMPOSE; + + if ($errors > 0) { + return $errors; + } + + # Print Docbook output + open my $OUTPUT, '>', $output_filename + or die "Could not create $output_filename: $!"; + + print $OUTPUT + join ("\n", + qq(<?xml version="1.0" encoding="$charset" ?>), + q(<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"), + q( "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">), + qq(<section id="$locale_name">), + qq(<title>Xlib Compose Keys for $locale_name</title>), + q(<para>Applications using Xlib input handling should recognize), + q( these compose key sequences in locales using the), + qq( $locale_name compose table.</para>), + "\n" + ); + + if (@included_files) { + print $OUTPUT + q(<para>This compose table includes the non-conflicting), + q( entries from: ), + join(',', @included_files), + q(. Those entries are not shown here - see those charts for the), + q( included key sequences.</para>), + "\n"; + } + + my @pretable_comments = (); + + if ($keyseq_count == 0) { + @pretable_comments = @compose_table; + } elsif ($compose_table[0]->{-type} eq 'comment') { + push @pretable_comments, shift @compose_table; + } + + foreach my $comment_ref (@pretable_comments) { + print $OUTPUT + qq(<para>), xml_escape($comment_ref->{-comment}), qq(</para>\n); + } + + if ($keyseq_count > 0) { + start_table($OUTPUT); + my $row_count = 0; + + foreach my $cr (@compose_table) { + + if ($row_count++ > 750) { + # Break tables every 750 rows to avoid overflowing + # xmlto/xsltproc limits on the largest tables + end_table($OUTPUT); + start_table($OUTPUT); + $row_count = 0; + } + + if ($cr->{-type} eq 'comment') { + print $OUTPUT + qq(<row><entry namest='seq' nameend='action'>), + xml_escape($cr->{-comment}), qq(</entry></row>\n); + } elsif ($cr->{-type} eq 'keyseq') { + my $action = join(" ", xml_escape($cr->{-action})); + if ($action =~ m{^\s*"\\([0-7]+)"}) { + my $char = oct($1); + if ($char >= 32) { + $action =~ s{^\s*"\\[0-7]+"}{"&#$char;"}; + } + } + $action =~ s{^\s*"(.+)"}{"$1"}; + + print $OUTPUT + qq(<row><entry>), + qq(<keycombo action='seq'>), + (map { qq(<keysym>$_</keysym>) } xml_escape(@{$cr->{-keys}})), + qq(</keycombo>), + qq(</entry><entry>), + $action, + qq(</entry></row>\n); + } + } + + end_table($OUTPUT); + } else { + print $OUTPUT + qq(<para><emphasis>), + qq(This compose table defines no sequences of its own.), + qq(</emphasis></para>\n); + } + print $OUTPUT "</section>\n"; + + close $OUTPUT or die "Couldn't write $output_filename: $!"; + + return $errors; +} + +sub xml_escape { + my @output; + + foreach my $l (@_) { + $l =~ s{\&}{&}g; + $l =~ s{\<}{<}g; + $l =~ s{\>}{>}g; + push @output, $l; + } + return @output; +} + +sub start_table { + my ($OUTPUT) = @_; + + print $OUTPUT + join("\n", + qq(<table><title>Compose Key Sequences for $locale_name</title>), + qq(<tgroup cols='2'>), + qq( <colspec colname='seq' /><colspec colname='action' />), + qq( <thead><row>), + qq( <entry>Key Sequence</entry><entry>Action</entry>), + qq( </row></thead>), + qq( <tbody>\n), + ); +} + +sub end_table { + my ($OUTPUT) = @_; + + print $OUTPUT "</tbody>\n</tgroup>\n</table>\n"; +} + +__END__ + +=head1 NAME + +compose-chart - Make DocBook/XML charts of compose table entries + +=head1 SYNOPSIS + +compose-chart [options] [file ...] + + Options: + --charset[=<cset>] character set to specify in XML doctype + --locale=<locale> name of locale to display in chart + --output=<file> filename to output chart to + --index make index of charts instead of individual chart + --help brief help message + --man full documentation + +=head1 OPTIONS + +=over 8 + +=item B<--charset>[=I<cset>] + +Specify a character set to list in the doctype declaration in the XML output. +If not specified, attempts to guess from the locale name, else default to +"utf-8". + +=item B<--locale>=I<locale> + +Specify the locale name to use in the chart titles and introductory text. + +=item B<--output>=I<file> + +Specify the output file to write the DocBook output to. + +=item B<--index> + +Generate an index of the listed locale charts instead of a chart for a +specific locale. + +=item B<--help> + +Print a brief help message and exit. + +=item B<--man> + +Print the manual page and exit. + +=back + +=head1 DESCRIPTION + +This program will read the given compose table file(s) and generate +DocBook/XML charts listing the available characters for end-user reference. + +=cut diff --git a/libX11/specs/i18n/compose/docbook-nl.am b/libX11/specs/i18n/compose/docbook-nl.am new file mode 100644 index 000000000..95860c297 --- /dev/null +++ b/libX11/specs/i18n/compose/docbook-nl.am @@ -0,0 +1,128 @@ +# +# Generate output formats for a single DocBook/XML with/without chapters +# +# This version of docbook.am handles cases where XML source is generated +# and the html to be produced must be in chunks, one per chapter. +# The generated source must be cleaned, installed but not distributed +# +# Variables set by the calling Makefile: +# shelfdir: the location where the docs/specs are installed. Typically $(docdir) +# docbook: the main DocBook/XML file, no chapters, appendix or image files +# chapters: all files pulled in by an XInclude statement and images. +# + +# +# This makefile is intended for Users Documentation and Functional Specifications. +# Do not use for Developer Documentation which is not installed and does not require olink. +# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393 +# for an explanation on documents classification. +# + +# DocBook/XML generated output formats to be installed +shelf_DATA = $(chapters) $(docbook) + +# Generated DocBook/XML source files using a perl script +%.xml: $(top_builddir)/nls/%/Compose + $(AM_V_GEN)$(PERL) $(srcdir)/compose-chart.pl \ + --locale="$(@:.xml=)" --output="$@" $< + +libX11-keys.xml: $(locales:%=%.xml) + $(AM_V_GEN)$(PERL) $(srcdir)/compose-chart.pl \ + --index --output="$@" $(locales) + +if HAVE_XMLTO +if HAVE_STYLESHEETS + +XMLTO_SEARCHPATH_FLAGS = \ + --searchpath "$(XORG_SGML_PATH)/X11" \ + --searchpath "$(abs_top_builddir)" +XMLTO_HTML_OLINK_FLAGS = \ + --stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.html.xml \ + --stringparam current.docid="$(<:.xml=)" +XMLTO_HTML_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-chunk.xsl +XMLTO_TXT_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl +XMLTO_HTML_CHUNKING_FLAGS = \ + --stringparam root.filename="$(<:.xml=)" +XMLTO_HTML_FLAGS = \ + $(XMLTO_SEARCHPATH_FLAGS) \ + $(XMLTO_HTML_STYLESHEET_FLAGS) \ + $(XMLTO_HTML_CHUNKING_FLAGS) \ + $(XMLTO_HTML_OLINK_FLAGS) +XMLTO_TXT_FLAGS = \ + $(XMLTO_SEARCHPATH_FLAGS) \ + $(XMLTO_TXT_STYLESHEET_FLAGS) \ + $(XMLTO_HTML_OLINK_FLAGS) + +shelf_DATA += $(docbook:.xml=.html) $(chapters:.xml=.html) +%.html: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) xhtml $< + +if HAVE_XMLTO_TEXT + +shelf_DATA += $(docbook:.xml=.txt) +%.txt: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_TXT_FLAGS) txt $< +endif HAVE_XMLTO_TEXT + +if HAVE_FOP +XMLTO_FO_IMAGEPATH_FLAGS = --stringparam img.src.path=$(abs_builddir)/ +XMLTO_FO_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-fo.xsl +XMLTO_PDF_OLINK_FLAGS = \ + --stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.pdf.xml \ + --stringparam current.docid="$(<:.xml=)" +XMLTO_FO_FLAGS = \ + $(XMLTO_SEARCHPATH_FLAGS) \ + $(XMLTO_FO_STYLESHEET_FLAGS) \ + $(XMLTO_FO_IMAGEPATH_FLAGS) \ + $(XMLTO_PDF_OLINK_FLAGS) + +shelf_DATA += $(docbook:.xml=.pdf) +%.pdf: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop pdf $< + +shelf_DATA += $(docbook:.xml=.ps) +%.ps: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop ps $< +endif HAVE_FOP + +# Generate documents cross-reference target databases +if HAVE_XSLTPROC + +XSLT_SEARCHPATH_FLAGS = \ + --path "$(XORG_SGML_PATH)/X11" \ + --path "$(abs_top_builddir)" +XSLT_OLINK_FLAGS = \ + --stringparam targets.filename "$@" \ + --stringparam collect.xref.targets "only" +XSLT_FO_OLINK_FLAGS = \ + --stringparam olink.base.uri "$(@:.db=)" +XSLT_HTML_CHUNKING_FLAGS = \ + --stringparam root.filename "$(<:.xml=)" + +XSLT_HTML_FLAGS = \ + $(XSLT_SEARCHPATH_FLAGS) \ + $(XSLT_HTML_CHUNKING_FLAGS) \ + $(XSLT_OLINK_FLAGS) \ + --nonet --xinclude \ + $(STYLESHEET_SRCDIR)/xorg-chunk.xsl + +XSLT_PDF_FLAGS = \ + $(XSLT_SEARCHPATH_FLAGS) \ + $(XSLT_OLINK_FLAGS) \ + $(XSLT_FO_OLINK_FLAGS) \ + --nonet --xinclude \ + $(STYLESHEET_SRCDIR)/xorg-fo.xsl + +shelf_DATA += $(docbook:.xml=.html.db) +%.html.db: %.xml $(chapters) + $(AM_V_GEN)$(XSLTPROC) $(XSLT_HTML_FLAGS) $< + +shelf_DATA += $(docbook:.xml=.pdf.db) +%.pdf.db: %.xml $(chapters) + $(AM_V_GEN)$(XSLTPROC) $(XSLT_PDF_FLAGS) $< + +endif HAVE_XSLTPROC +endif HAVE_STYLESHEETS +endif HAVE_XMLTO + +CLEANFILES = $(shelf_DATA) |