diff options
Diffstat (limited to 'contrib/libxo')
429 files changed, 53914 insertions, 0 deletions
diff --git a/contrib/libxo/.gitignore b/contrib/libxo/.gitignore new file mode 100644 index 000000000000..f4ace8fe0a81 --- /dev/null +++ b/contrib/libxo/.gitignore @@ -0,0 +1,32 @@ +tag.sh +Makefile.in +aclocal.m4 +ar-lib +autom4te.cache +bin +build* +compile +configure +config.guess +config.sub +depcomp +doc/Makefile.in +info* +install-sh +ltmain.sh +m4 +missing +patches* +doc/Makefile.in +encoder/Makefile.in +encoder/cbor/Makefile.in +encoder/test/Makefile.in +libxo/Makefile.in +tests/Makefile.in +tests/core/Makefile.in +tests/gettext/Makefile.in +tests/xo/Makefile.in +xo/Makefile.in +xohtml/Makefile.in +xolint/Makefile.in +xopo/Makefile.in diff --git a/contrib/libxo/.travis.yml b/contrib/libxo/.travis.yml new file mode 100644 index 000000000000..1173578bbd5d --- /dev/null +++ b/contrib/libxo/.travis.yml @@ -0,0 +1,12 @@ +language: c + +script: printenv && uname -a && ls -l && /bin/sh -x ./bin/setup.sh && cd build && ../configure --enable-warnings && make && sudo make install && make test + +notifications: + recipients: + - libslax-noise@googlegroups.com + +branches: + only: + - master + - develop diff --git a/contrib/libxo/Copyright b/contrib/libxo/Copyright new file mode 100644 index 000000000000..94ba75e4ffa2 --- /dev/null +++ b/contrib/libxo/Copyright @@ -0,0 +1,23 @@ +Copyright (c) 2014 Juniper Networks, Inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. diff --git a/contrib/libxo/INSTALL.md b/contrib/libxo/INSTALL.md new file mode 100644 index 000000000000..70b80bcea926 --- /dev/null +++ b/contrib/libxo/INSTALL.md @@ -0,0 +1,15 @@ +<!--- +# $Id$ +# +# Copyright 2015, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. +#--> + +## Instructions for building libxo + +Instructions for building libxo are now available in the +[wiki](http://juniper.github.io/libxo/libxo-manual.html#getting-libxo). diff --git a/contrib/libxo/LICENSE b/contrib/libxo/LICENSE new file mode 100644 index 000000000000..874da7b2d8a8 --- /dev/null +++ b/contrib/libxo/LICENSE @@ -0,0 +1,23 @@ +Copyright (c) 2014, Juniper Networks +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/contrib/libxo/Makefile.am b/contrib/libxo/Makefile.am new file mode 100644 index 000000000000..617e3b1af871 --- /dev/null +++ b/contrib/libxo/Makefile.am @@ -0,0 +1,144 @@ +# +# $Id$ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +ACLOCAL_AMFLAGS = -I m4 + +SUBDIRS = bin libxo xo xopo xolint xohtml tests doc encoder +bin_SCRIPTS=libxo-config +dist_doc_DATA = Copyright + +EXTRA_DIST = \ + libxo-config.in \ + warnings.mk \ + README.md \ + INSTALL.md \ + packaging/libxo.spec + +.PHONY: test tests + +test tests: + @(cd tests ; ${MAKE} test) + +errors: + @(cd tests/errors ; ${MAKE} test) + +docs: + @(cd doc ; ${MAKE} docs) + +DIST_FILES_DIR = ~/Dropbox/dist-files/ +GH_PAGES_DIR = gh-pages/ +GH_PAGES_DIR_VER = gh-pages/${PACKAGE_VERSION} +PACKAGE_FILE = ${PACKAGE_TARNAME}-${PACKAGE_VERSION}.tar.gz + +XOHTML_FILES = \ + ${top_srcdir}/xohtml/xohtml.css \ + ${top_srcdir}/xohtml/xohtml.js \ + ${top_srcdir}/xohtml/external/jquery.js \ + ${top_srcdir}/xohtml/external/jquery.qtip.css \ + ${top_srcdir}/xohtml/external/jquery.qtip.js + +upload: dist upload-docs upload-xohtml-files + @echo "Remember to run:" + @echo " gt tag ${PACKAGE_VERSION}" + +upload-docs: docs upload-html + +upload-html: + @echo "Uploading html ... " + @-[ -d ${GH_PAGES_DIR} -a -d doc/html ] \ + && echo "Updating html on gh-pages ..." \ + && mkdir -p ${GH_PAGES_DIR_VER}/html \ + && cp doc/top-link.html ${GH_PAGES_DIR}/libxo.html \ + && cp -r doc/html/* ${GH_PAGES_DIR_VER}/html/ \ + && (cd ${GH_PAGES_DIR} \ + && git add libxo.html \ + && git add ${PACKAGE_VERSION}/html \ + && git commit -m 'new docs' \ + libxo.html ${PACKAGE_VERSION}/html \ + && git push origin gh-pages ) ; true + +upload-xohtml-files: + @echo "Uploading xohtml files ... " + @-[ -d ${GH_PAGES_DIR} ] \ + && echo "Updating xohtml files on gh-pages ..." \ + && mkdir -p ${GH_PAGES_DIR_VER}/xohtml \ + && cp ${XOHTML_FILES} ${GH_PAGES_DIR_VER}/xohtml \ + && (cd ${GH_PAGES_DIR} \ + && git add ${PACKAGE_VERSION}/xohtml \ + && git commit -m 'new xohtml files' \ + ${PACKAGE_VERSION}/xohtml \ + && git push origin gh-pages ) ; true + +pkgconfigdir=$(libdir)/pkgconfig +pkgconfig_DATA = packaging/${PACKAGE_NAME}.pc + +get-wiki: + git clone https://github.com/Juniper/${PACKAGE_NAME}.wiki.git wiki + +get-gh-pages: + git clone https://github.com/Juniper/${PACKAGE_NAME}.git \ + gh-pages -b gh-pages + +UPDATE_PACKAGE_FILE = \ + -e "s;__SHA1__;$$SHA1;" \ + -e "s;__SHA256__;SHA256 (textproc/${PACKAGE_FILE}) = $$SHA256;" \ + -e "s;__SIZE__;SIZE (textproc/${PACKAGE_FILE}) = $$SIZE;" + +GH_PACKAGING_DIR = ${PACKAGE_VERSION}/packaging +GH_PAGES_PACKAGE_DIR = ${GH_PAGES_DIR}/${GH_PACKAGING_DIR} + +packages: + @-[ -d ${GH_PAGES_DIR} ] && set -x \ + && echo "Updating packages on gh-pages ..." \ + && mkdir -p ${GH_PAGES_DIR}/${GH_PACKAGING_DIR} \ + && SHA1="`openssl sha1 ${PACKAGE_FILE} | awk '{print $$2}'`" \ + && SHA256="`openssl sha256 ${PACKAGE_FILE} | awk '{print $$2}'`" \ + && SIZE="`ls -l ${PACKAGE_FILE} | awk '{print $$5}'`" \ + && echo "... ${GH_PAGES_PACKAGE_DIR}/${PACKAGE_NAME}.rb ..." \ + && sed ${UPDATE_PACKAGE_FILE} \ + packaging/${PACKAGE_NAME}.rb.base \ + > ${GH_PAGES_PACKAGE_DIR}/${PACKAGE_NAME}.rb \ + && echo "... ${GH_PAGES_PACKAGE_DIR}/${PACKAGE_NAME}.spec ..." \ + && cp packaging/${PACKAGE_NAME}.spec \ + ${GH_PAGES_PACKAGE_DIR}/${PACKAGE_NAME}.spec \ + && (cd ${GH_PAGES_DIR} \ + && git add ${GH_PACKAGING_DIR} \ + && git add ${GH_PACKAGING_DIR}/libxo.rb \ + ${GH_PACKAGING_DIR}/libxo.spec \ + && git commit -m 'new packaging data' \ + ${GH_PACKAGING_DIR} \ + && git push origin gh-pages ) ; true + +ANALYZE_DIR = ~/trash/libxo +ANALYZE_CMD = scan-build-mp-3.6 + +analyze: + ${MAKE} clean + ${ANALYZE_CMD} -o ${ANALYZE_DIR} ${MAKE} + +SANIFLAGS=-fno-omit-frame-pointer -g -O2 + +sanitize-address: + ${MAKE} clean + ${MAKE} CFLAGS="-fsanitize=address ${SANIFLAGS}" + ${MAKE} install + ${MAKE} test + +sanitize-undefined: + ${MAKE} clean + ${MAKE} CFLAGS="-fsanitize=undefined ${SANIFLAGS}" + ${MAKE} install + ${MAKE} test + +sanitize-memory: + ${MAKE} clean + ${MAKE} CFLAGS="-fsanitize=memory ${SANIFLAGS}" + ${MAKE} install + ${MAKE} test diff --git a/contrib/libxo/README.md b/contrib/libxo/README.md new file mode 100644 index 000000000000..fdba97a001bb --- /dev/null +++ b/contrib/libxo/README.md @@ -0,0 +1,67 @@ +libxo +===== + +libxo - A Library for Generating Text, XML, JSON, and HTML Output + +The libxo library allows an application to generate text, XML, JSON, +and HTML output using a common set of function calls. The application +decides at run time which output style should be produced. The +application calls a function "xo_emit" to product output that is +described in a format string. A "field descriptor" tells libxo what +the field is and what it means. + +Imagine a simplified ``wc`` that emits its output fields in a single +xo_emit call: + +``` + xo_emit(" {:lines/%7ju/%ju} {:words/%7ju/%ju} " + "{:characters/%7ju/%ju}{d:filename/%s}\n", + linect, wordct, charct, file); +``` + +Output can then be generated in various style, using the "--libxo" +option: + +``` + % wc /etc/motd + 25 165 1140 /etc/motd + % wc --libxo xml,pretty,warn /etc/motd + <wc> + <file> + <filename>/etc/motd</filename> + <lines>25</lines> + <words>165</words> + <characters>1140</characters> + </file> + </wc> + % wc --libxo json,pretty,warn /etc/motd + { + "wc": { + "file": [ + { + "filename": "/etc/motd", + "lines": 25, + "words": 165, + "characters": 1140 + } + ] + } + } + % wc --libxo html,pretty,warn /etc/motd + <div class="line"> + <div class="text"> </div> + <div class="data" data-tag="lines"> 25</div> + <div class="text"> </div> + <div class="data" data-tag="words"> 165</div> + <div class="text"> </div> + <div class="data" data-tag="characters"> 1140</div> + <div class="text"> </div> + <div class="data" data-tag="filename">/etc/motd</div> + </div> +``` + +View the beautiful documentation at: + +http://juniper.github.io/libxo/libxo-manual.html + +[](https://github.com/Juniper/libxo) diff --git a/contrib/libxo/configure.ac b/contrib/libxo/configure.ac new file mode 100644 index 000000000000..2f5681d4276f --- /dev/null +++ b/contrib/libxo/configure.ac @@ -0,0 +1,500 @@ +# +# $Id$ +# +# See ./INSTALL for more info +# + +# +# Release numbering: even numbered dot releases are official ones, and +# odd numbers are development ones. The svn version of this file will +# only (ONLY!) ever (EVER!) contain odd numbers, so I'll always know if +# a particular user has the dist or svn release. +# + +AC_PREREQ([2.69]) +AC_INIT([libxo],[1.6.0],[phil@juniper.net]) +AM_INIT_AUTOMAKE([-Wall -Werror foreign -Wno-portability]) + +# Support silent build rules. Requires at least automake-1.11. +# Disable with "configure --disable-silent-rules" or "make V=1" +m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) + +AC_PROG_CC +AC_PROG_INSTALL +AC_CONFIG_MACRO_DIR([m4]) +AC_PROG_LN_S + +# Must be after AC_PROG_AR +LT_INIT([dlopen shared]) + +AC_PATH_PROG(BASENAME, basename, /usr/bin/basename) +AC_PATH_PROG(BISON, bison, /usr/bin/bison) +AC_PATH_PROG(CAT, cat, /bin/cat) +AC_PATH_PROG(CHMOD, chmod, /bin/chmod) +AC_PATH_PROG(CP, cp, /bin/cp) +AC_PATH_PROG(DIFF, diff, /usr/bin/diff) +AC_PATH_PROG(MKDIR, mkdir, /bin/mkdir) +AC_PATH_PROG(MV, mv, /bin/mv) +AC_PATH_PROG(RM, rm, /bin/rm) +AC_PATH_PROG(SED, sed, /bin/sed) + +# Checks for typedefs, structures, and compiler characteristics. +AC_C_INLINE +AC_TYPE_SIZE_T + +# Checks for library functions. +AC_FUNC_ALLOCA +AC_FUNC_MALLOC +AC_FUNC_REALLOC +AC_CHECK_FUNCS([bzero memmove strchr strcspn strerror strspn]) +AC_CHECK_FUNCS([sranddev srand strlcpy]) +AC_CHECK_FUNCS([fdopen getrusage]) +AC_CHECK_FUNCS([gettimeofday ctime]) +AC_CHECK_FUNCS([getpass]) +AC_CHECK_FUNCS([getprogname]) +AC_CHECK_FUNCS([sysctlbyname]) +AC_CHECK_FUNCS([flock]) +AC_CHECK_FUNCS([asprintf]) +AC_CHECK_FUNCS([__flbf]) +AC_CHECK_FUNCS([sysctlbyname]) + + +AC_CHECK_HEADERS([dlfcn.h]) +AC_CHECK_HEADERS([dlfcn.h]) +AC_CHECK_HEADERS([stdio_ext.h]) +AC_CHECK_HEADERS([tzfile.h]) +AC_CHECK_HEADERS([stdtime/tzfile.h]) +AC_CHECK_FUNCS([dlfunc]) + +AC_CHECK_HEADERS([sys/time.h]) +AC_CHECK_HEADERS([ctype.h errno.h stdio.h stdlib.h]) +AC_CHECK_HEADERS([string.h sys/param.h unistd.h ]) +AC_CHECK_HEADERS([sys/sysctl.h]) +AC_CHECK_HEADERS([threads.h]) +AC_CHECK_HEADERS([monitor.h]) + +dnl humanize_number(3) is a great function, but it's not standard. +dnl Note Macosx has the function in libutil.a but doesn't ship the +dnl header file, so I'll need to carry my own implementation. See: +dnl https://devforums.apple.com/thread/271121 +AC_CHECK_HEADERS([libutil.h]) +AC_CHECK_LIB([util], [humanize_number], + [HAVE_HUMANIZE_NUMBER=$ac_cv_header_libutil_h], + [HAVE_HUMANIZE_NUMBER=no]) + +AC_MSG_RESULT(humanize_number results: :${HAVE_HUMANIZE_NUMBER}:${ac_cv_header_libutil_h}:) + +if test "$HAVE_HUMANIZE_NUMBER" = "yes"; then + AC_DEFINE([HAVE_HUMANIZE_NUMBER], [1], [humanize_number(3)]) +fi + +AM_CONDITIONAL([HAVE_HUMANIZE_NUMBER], [test "$HAVE_HUMANIZE_NUMBER" = "yes"]) + +AC_ARG_ENABLE([gettext], + [ --disable-gettext Turn off support for gettext], + [GETTEXT_ENABLE=$enableval], + [GETTEXT_ENABLE=yes]) + +dnl Looking for gettext(), assumably in libintl +AC_ARG_WITH(gettext, + [ --with-gettext=[PFX] Specify location of gettext installation], + [GETTEXT_PREFIX=$withval], + [GETTEXT_PREFIX=/usr], +) + +HAVE_GETTEXT=no + +if test "$GETTEXT_ENABLE" != "no"; then + + AC_MSG_CHECKING([gettext in ${GETTEXT_PREFIX}]) + + _save_cflags="$CFLAGS" + CFLAGS="$CFLAGS -I${GETTEXT_PREFIX}/include -L${GETTEXT_PREFIX}/lib -Werror -lintl" + AC_LINK_IFELSE([AC_LANG_SOURCE([[#include <libintl.h>] + [int main() {char *cp = dgettext(NULL, "xx"); return 0; }]])], + [HAVE_GETTEXT=yes], + [HAVE_GETTEXT=no]) + CFLAGS="$_save_cflags" + + AC_MSG_RESULT([$HAVE_GETTEXT]) + + if test "$HAVE_GETTEXT" != "yes"; then + GETTEXT_PREFIX=/opt/local + AC_MSG_CHECKING([gettext in ${GETTEXT_PREFIX}]) + + _save_cflags="$CFLAGS" + CFLAGS="$CFLAGS -I${GETTEXT_PREFIX}/include -L${GETTEXT_PREFIX}/lib -Werror -lintl" + AC_LINK_IFELSE([AC_LANG_SOURCE([[#include <libintl.h>] + [int main() {char *cp = dgettext(NULL, "xx"); return 0; }]])], + [HAVE_GETTEXT=yes], + [HAVE_GETTEXT=no]) + CFLAGS="$_save_cflags" + + AC_MSG_RESULT([$HAVE_GETTEXT]) + fi + + if test "$HAVE_GETTEXT" != "yes"; then + GETTEXT_PREFIX=/usr/local + AC_MSG_CHECKING([gettext in ${GETTEXT_PREFIX}]) + + _save_cflags="$CFLAGS" + CFLAGS="$CFLAGS -I${GETTEXT_PREFIX}/include -L${GETTEXT_PREFIX}/lib -Werror -lintl" + AC_LINK_IFELSE([AC_LANG_SOURCE([[#include <libintl.h>] + [int main() {char *cp = dgettext(NULL, "xx"); return 0; }]])], + [HAVE_GETTEXT=yes], + [HAVE_GETTEXT=no]) + CFLAGS="$_save_cflags" + + AC_MSG_RESULT([$HAVE_GETTEXT]) + fi +fi + +if test "$HAVE_GETTEXT" = "yes"; then + AC_DEFINE([HAVE_GETTEXT], [1], [gettext(3)]) + GETTEXT_CFLAGS="-I${GETTEXT_PREFIX}/include" + GETTEXT_LIBS="-L${GETTEXT_PREFIX}/lib -lintl" +else + GETTEXT_PREFIX=none + GETTEXT_CFLAGS= + GETTEXT_LIBS= +fi +AC_SUBST(GETTEXT_CFLAGS) +AC_SUBST(GETTEXT_LIBS) + +GETTEXT_LIBDIR=${GETTEXT_PREFIX}/lib +AC_SUBST(GETTEXT_LIBDIR) +if test -x ${GETTEXT_PREFIX}/bin/msgfmt ; then + GETTEXT_BINDIR=${GETTEXT_PREFIX}/bin +elif test -x ${GETTEXT_PREFIX}/local/bin/msgfmt ; then + GETTEXT_BINDIR=${GETTEXT_PREFIX}/local/bin +else + AC_MSG_NOTICE("could not find msgfmt tool") + # Use a (bad) fall back value + GETTEXT_BINDIR=${GETTEXT_PREFIX}/bin +fi +AC_SUBST(GETTEXT_BINDIR) + +AM_CONDITIONAL([HAVE_GETTEXT], [test "$HAVE_GETTEXT" = "yes"]) + +dnl Looking for how to do thread-local variables +AC_ARG_WITH(threads, + [ --with-threads=[STYLE] Specify style of thread-local support (none)], + [THREAD_LOCAL=$withval], + [THREAD_LOCAL=unknown], +) + +AC_MSG_CHECKING([thread-locals are ${THREAD_LOCAL}]) + +if test "$THREAD_LOCAL" = "unknown"; then + AC_LINK_IFELSE([AC_LANG_SOURCE([[] + [__thread int foo; int main() { foo++; return foo; }]])], + [THREAD_LOCAL=before], + [THREAD_LOCAL=unknown]) + + AC_MSG_RESULT([$THREAD_LOCAL]) +fi + +if test "$THREAD_LOCAL" = "unknown"; then + AC_LINK_IFELSE([AC_LANG_SOURCE([[] + [int __thread foo; int main() { foo++; return foo; }]])], + [THREAD_LOCAL=after], + [THREAD_LOCAL=unknown]) + AC_MSG_RESULT([$THREAD_LOCAL]) +fi + +if test "$THREAD_LOCAL" = "unknown"; then + AC_LINK_IFELSE([AC_LANG_SOURCE([[] + [__declspec(int) foo; int main() { foo++; return foo; }]])], + [THREAD_LOCAL=declspec], + [THREAD_LOCAL=unknown]) + AC_MSG_RESULT([$THREAD_LOCAL]) +fi + +if test "$THREAD_LOCAL" != "unknown"; then + AC_DEFINE_UNQUOTED([HAVE_THREAD_LOCAL], + THREAD_LOCAL_${THREAD_LOCAL}, [thread-local setting]) +fi + +dnl Looking for libcrypto.... +AC_CHECK_LIB([crypto], [MD5_Init]) +AM_CONDITIONAL([HAVE_LIBCRYPTO], [test "$HAVE_LIBCRYPTO" != "no"]) + +AC_CHECK_MEMBER([struct sockaddr_un.sun_len], + [HAVE_SUN_LEN=yes ; + AC_DEFINE([HAVE_SUN_LEN], [1], [Have struct sockaddr_un.sun_len])], + [HAS_SUN_LEN=no], [[#include <sys/un.h>]]) + +AC_CHECK_DECLS([__isthreaded], [], [], [#include <stdio.h>]) +HAVE_ISTHREADED=${ac_cv_have_decl___isthreaded} + +dnl +dnl Some packages need to be checked against version numbers so we +dnl define a function here for later use +dnl +AC_DEFUN([VERSION_TO_NUMBER], +[`$1 | sed -e 's/lib.* //' | awk 'BEGIN { FS = "."; } { printf "%d", ([$]1 * 1000 + [$]2) * 1000 + [$]3;}'`]) + +LIBSLAX_CONFIG_PREFIX="" +LIBSLAX_SRC="" + +AC_ARG_WITH(libslax-prefix, + [ --with-libslax-prefix=[PFX] Specify location of libslax config], + LIBSLAX_CONFIG_PREFIX=$withval +) + +AC_MSG_CHECKING(for libslax) +if test "x$LIBSLAX_CONFIG_PREFIX" != "x" +then + SLAX_CONFIG=${LIBSLAX_CONFIG_PREFIX}/bin/slax-config +else + SLAX_CONFIG=slax-config +fi + +dnl +dnl make sure slax-config is executable, +dnl test version and init our variables +dnl + +if ${SLAX_CONFIG} --libs > /dev/null 2>&1 +then + LIBSLAX_VERSION=`$SLAX_CONFIG --version` + SLAX_BINDIR="`$SLAX_CONFIG --bindir | head -1`" + SLAX_OXTRADOCDIR="`$SLAX_CONFIG --oxtradoc | head -1`" + AC_MSG_RESULT($LIBSLAX_VERSION found) + HAVE_OXTRADOC=yes +else + LIBSLAX_VERSION= + SLAX_BINDIR= + SLAX_OXTRADOCDIR= + AC_MSG_RESULT([no]) + HAVE_OXTRADOC=no +fi +AM_CONDITIONAL([HAVE_OXTRADOC], [test "$HAVE_OXTRADOC" != "no"]) + +AC_SUBST(SLAX_BINDIR) +AC_SUBST(SLAX_OXTRADOCDIR) + +AC_MSG_CHECKING([whether to build with warnings]) +AC_ARG_ENABLE([warnings], + [ --enable-warnings Turn on compiler warnings], + [LIBXO_WARNINGS=$enableval], + [LIBXO_WARNINGS=no]) +AC_MSG_RESULT([$LIBXO_WARNINGS]) +AM_CONDITIONAL([LIBXO_WARNINGS_HIGH], [test "$LIBXO_WARNINGS" != "no"]) + +AC_MSG_CHECKING([whether to build with debugging]) +AC_ARG_ENABLE([debug], + [ --enable-debug Turn on debugging], + [LIBXO_DEBUG=yes; AC_DEFINE([LIBXO_DEBUG], [1], [Enable debugging])], + [LIBXO_DEBUG=no]) +AC_MSG_RESULT([$LIBXO_DEBUG]) +AM_CONDITIONAL([LIBXO_DEBUG], [test "$LIBXO_DEBUG" != "no"]) + +AC_MSG_CHECKING([whether to use int return codes]) +AC_ARG_ENABLE([int-return-codes], + [ --enable-int-return-codes Use int return codes (instead of ssize_t)], + [USE_INT_RETURN_CODES=yes; AC_DEFINE([USE_INT_RETURN_CODES], [1], [Use int return codes])], + [USE_INT_RETURN_CODES=no]) +AC_MSG_RESULT([$USE_INT_RETURN_CODES]) + +AC_MSG_CHECKING([whether to build with text-only rendering]) +AC_ARG_ENABLE([text-only], + [ --enable-text-only Turn on text-only rendering], + [LIBXO_TEXT_ONLY=yes; AC_DEFINE([LIBXO_TEXT_ONLY], [1], [Enable text-only rendering])], + [LIBXO_TEXT_ONLY=no]) +AC_MSG_RESULT([$LIBXO_TEXT_ONLY]) +AM_CONDITIONAL([LIBXO_TEXT_ONLY], [test "$LIBXO_TEXT_ONLY" != "no"]) + +AC_MSG_CHECKING([whether to build with local wcwidth implementation]) +AC_ARG_ENABLE([wcwidth], + [ --disable-wcwidth Disable local wcwidth implementation], + [LIBXO_WCWIDTH=$enableval], + [LIBXO_WCWIDTH=yes]) +AC_MSG_RESULT([$LIBXO_WCWIDTH]) +if test "${LIBXO_WCWIDTH}" != "no"; then + AC_DEFINE([LIBXO_WCWIDTH], [1], [Enable local wcwidth implementation]) +fi + +AC_MSG_CHECKING([retain hash bucket size]) +AC_ARG_WITH(retain-size, + [ --with-retain-size=[DIR] Specify retain hash bucket size (in bits)], + [XO_RETAIN_SIZE=$withval], + [XO_RETAIN_SIZE=default] +) + +AC_MSG_RESULT([$XO_RETAIN_SIZE]) +if test "${XO_RETAIN_SIZE}" != "default"; then + AC_DEFINE_UNQUOTED([XO_RETAIN_SIZE], ${XO_RETAIN_SIZE}, [Retain hash bucket size]) +fi + +AC_CHECK_LIB([m], [lrint]) +AM_CONDITIONAL([HAVE_LIBM], [test "$HAVE_LIBM" != "no"]) + +AC_MSG_CHECKING([compiler for gcc]) +HAVE_GCC=no +if test "${CC}" != ""; then + HAVE_GCC=`${CC} --version 2>&1 | grep -i GCC` + if test "${HAVE_GCC}" != ""; then + HAVE_GCC=yes + AC_DEFINE([HAVE_GCC], [1], [Using real gcc]) + else + HAVE_GCC=no + fi +fi +AC_MSG_RESULT([$HAVE_GCC]) +AM_CONDITIONAL([HAVE_GCC], [test "$HAVE_GCC" = "yes"]) + +AC_MSG_CHECKING([whether to build with printflike]) +AC_ARG_ENABLE([printflike], + [ --enable-printflike Enable use of GCC __printflike attribute], + [HAVE_PRINTFLIKE=yes; + AC_DEFINE([HAVE_PRINTFLIKE], [1], [Support printflike])], + [HAVE_PRINTFLIKE=no]) +AC_MSG_RESULT([$HAVE_PRINTFLIKE]) +AM_CONDITIONAL([HAVE_PRINTFLIKE], [test "$HAVE_PRINTFLIKE" != ""]) + +AC_MSG_CHECKING([whether to build with LIBXO_OPTIONS]) +AC_ARG_ENABLE([libxo-options], + [ --disable-libxo-options Turn off support for LIBXO_OPTIONS], + [LIBXO_OPTS=$enableval], + [LIBXO_OPTS=yes]) +AC_MSG_RESULT([$LIBXO_OPTS]) +AM_CONDITIONAL([NO_LIBXO_OPTIONS], [test "$LIBXO_OPTS" != "yes"]) + +case $host_os in + darwin*) + LIBTOOL=glibtool + XO_LIBEXT=dylib + ;; + Linux*|linux*) + CFLAGS="-D_GNU_SOURCE $CFLAGS" + LDFLAGS=-ldl + XO_LIBEXT=so + ;; + cygwin*|CYGWIN*) + LDFLAGS=-no-undefined + XO_LIBEXT=ddl + ;; +esac + +case $prefix in + NONE) + prefix=/usr/local + ;; +esac + +XO_LIBS=-lxo +XO_SRCDIR=${srcdir} +XO_LIBDIR=${libdir} +XO_BINDIR=${bindir} +XO_INCLUDEDIR=${includedir} +XO_CFLAGS="${CFLAGS}" + +AC_SUBST(XO_LIBS) +AC_SUBST(XO_SRCDIR) +AC_SUBST(XO_LIBDIR) +AC_SUBST(XO_BINDIR) +AC_SUBST(XO_INCLUDEDIR) +AC_SUBST(XO_LIBEXT) +AC_SUBST(XO_CFLAGS) + +AC_ARG_WITH(encoder-dir, + [ --with-encoder-dir=[DIR] Specify location of encoder libraries], + [XO_ENCODERDIR=$withval], + [XO_ENCODERDIR=$libdir/libxo/encoder] +) +AC_SUBST(XO_ENCODERDIR) + +AC_ARG_WITH(share-dir, + [ --with-share-dir=[DIR] Specify location of shared files], + [XO_SHAREDIR=$withval], + [XO_SHAREDIR=$datarootdir/libxo] +) +XO_SHAREDIR=`echo $XO_SHAREDIR | sed "s;\\${prefix};$prefix;"` +AC_SUBST(XO_SHAREDIR) + +dnl for the spec file +RELDATE=`date +'%Y-%m-%d%n'` +AC_SUBST(RELDATE) + +AC_MSG_RESULT(Using configure dir $ac_abs_confdir) + +if test -d $ac_abs_confdir/.git ; then + extra=`git branch | awk '/\*/ { print $2 }'` + if test "$extra" != "" -a "$extra" != "master" + then + LIBXO_VERSION_EXTRA="-git-$extra" + fi +fi + +LIBXO_VERSION=$PACKAGE_VERSION +LIBXO_VERSION_NUMBER=VERSION_TO_NUMBER(echo $PACKAGE_VERSION) +AC_SUBST(LIBXO_VERSION) +AC_SUBST(LIBXO_VERSION_NUMBER) +AC_SUBST(LIBXO_VERSION_EXTRA) + +AC_DEFINE_UNQUOTED(LIBXO_VERSION, ["$LIBXO_VERSION"], + [Version number as dotted value]) +AC_DEFINE_UNQUOTED(LIBXO_VERSION_NUMBER, [$LIBXO_VERSION_NUMBER], + [Version number as a number]) +AC_DEFINE_UNQUOTED(LIBXO_VERSION_STRING, ["$LIBXO_VERSION_NUMBER"], + [Version number as string]) +AC_DEFINE_UNQUOTED(LIBXO_VERSION_EXTRA, ["$LIBXO_VERSION_EXTRA"], + [Version number extra information]) + +AC_CONFIG_HEADERS([libxo/xo_config.h]) +AC_CONFIG_FILES([ + Makefile + libxo-config + xohtml/xohtml.sh + libxo/Makefile + libxo/add.man + bin/Makefile + encoder/Makefile + encoder/cbor/Makefile + encoder/csv/Makefile + encoder/test/Makefile + xo/Makefile + xolint/Makefile + xohtml/Makefile + xopo/Makefile + packaging/libxo.pc + doc/Makefile + doc/top-link.html + tests/Makefile + tests/core/Makefile + tests/gettext/Makefile + tests/xo/Makefile + packaging/libxo.spec + packaging/libxo.rb.base +]) +AC_OUTPUT + +AC_MSG_NOTICE([summary of build options: + + libxo version: ${VERSION} ${LIBXO_VERSION_EXTRA} + host type: ${host} / ${host_os} + install prefix: ${prefix} + srcdir: ${XO_SRCDIR} + libdir: ${XO_LIBDIR} + bindir: ${XO_BINDIR} + includedir: ${XO_INCLUDEDIR} + share dir: ${XO_SHAREDIR} + extensions dir: ${XO_ENCODERDIR} + oxtradoc dir: ${SLAX_OXTRADOCDIR} + + compiler: ${CC} (${HAVE_GCC:-no}) + compiler flags: ${CFLAGS} + library types: Shared=${enable_shared}, Static=${enable_static} + + warnings: ${LIBXO_WARNINGS:-no} + debug: ${LIBXO_DEBUG:-no} + printf-like: ${HAVE_PRINTFLIKE:-no} + libxo-options: ${LIBXO_OPTS:-no} + text-only: ${LIBXO_TEXT_ONLY:-no} + gettext: ${HAVE_GETTEXT:-no} (${GETTEXT_PREFIX}) + isthreaded: ${HAVE_ISTHREADED:-no} + thread-local: ${THREAD_LOCAL:-no} + local wcwidth: ${LIBXO_WCWIDTH:-no} + retain size: ${XO_RETAIN_SIZE:-no} +]) diff --git a/contrib/libxo/doc/Makefile.am b/contrib/libxo/doc/Makefile.am new file mode 100644 index 000000000000..dcd155e95f23 --- /dev/null +++ b/contrib/libxo/doc/Makefile.am @@ -0,0 +1,29 @@ +# +# $Id$ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +doc docs: xolint-errors.rst html + +# +# The contents of xolint.rst is generated based on xolint.pl, since we +# really want this to be self-documenting. But readthedocs.org needs this +# data to be _in_ repo. So we generate this file on command only, and +# the developer needs to commit any changes. +# + +xolint-errors.rst: ${top_srcdir}/xolint/xolint.pl + perl ${top_srcdir}/xolint/xolint.pl -D > ${top_srcdir}/doc/xolint-errors.rst + +SPHINX = python3 -msphinx + +html sphinx sphinx-html: + ${SPHINX} -M html ${srcdir} . -N -E + +singlehtml: + ${SPHINX} -M singlehtml ${srcdir} . -N -E diff --git a/contrib/libxo/doc/_static/basic.css_t b/contrib/libxo/doc/_static/basic.css_t new file mode 100644 index 000000000000..e8ebdc780dbc --- /dev/null +++ b/contrib/libxo/doc/_static/basic.css_t @@ -0,0 +1,657 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: {{ theme_sidebarwidth|toint }}px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +blockquote.epigraph p.attribution { + margin-left: 50%; +} + +blockquote.epigraph { + background-color: #eee; + padding: 0.5em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { +/* clear: right; */ + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 1em 1em 1em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +dl.function table.docutils th.field-name { + width: 100px; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 1px solid #aaa; + border-left: 1px solid #aaa; + border-right: 1px solid #aaa; + border-bottom: 1px solid #aaa; +} + +table.docutils th { + border-bottom: 2px solid #aaa; + background-color: #f2f2f2; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} diff --git a/contrib/libxo/doc/_templates/localtoc.html b/contrib/libxo/doc/_templates/localtoc.html new file mode 100644 index 000000000000..14fdb12a53cc --- /dev/null +++ b/contrib/libxo/doc/_templates/localtoc.html @@ -0,0 +1,14 @@ +{# + basic/localtoc.html + ~~~~~~~~~~~~~~~~~~~ + + Sphinx sidebar template: local table of contents. + + :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- if display_toc %} + <h3><a href="{{ pathto(master_doc) }}">{{ _('On This Page') }}</a></h3> + {{ toc }} + <h3><a href="{{ pathto(master_doc) }}">{{ _('Full Documentation') }}</a></h3> +{%- endif %} diff --git a/contrib/libxo/doc/api.rst b/contrib/libxo/doc/api.rst new file mode 100644 index 000000000000..8a9b7bb5cefe --- /dev/null +++ b/contrib/libxo/doc/api.rst @@ -0,0 +1,1702 @@ +.. index:: API + +The libxo API +============= + +This section gives details about the functions in libxo, how to call +them, and the actions they perform. + +.. index:: Handles +.. _handles: + +Handles +------- + +libxo uses "handles" to control its rendering functionality. The +handle contains state and buffered data, as well as callback functions +to process data. + +Handles give an abstraction for libxo that encapsulates the state of a +stream of output. Handles have the data type "`xo_handle_t`" and are +opaque to the caller. + +The library has a default handle that is automatically initialized. +By default, this handle will send text style output (`XO_STYLE_TEXT`) to +standard output. The xo_set_style and xo_set_flags functions can be +used to change this behavior. + +For the typical command that is generating output on standard output, +there is no need to create an explicit handle, but they are available +when needed, e.g., for daemons that generate multiple streams of +output. + +Many libxo functions take a handle as their first parameter; most that +do not use the default handle. Any function taking a handle can be +passed NULL to access the default handle. For the convenience of +callers, the libxo library includes handle-less functions that +implicitly use the default handle. + +For example, the following are equivalent:: + + xo_emit("test"); + xo_emit_h(NULL, "test"); + +Handles are created using `xo_create` and destroy using +`xo_destroy`. + +.. index:: xo_create + +xo_create +~~~~~~~~~ + +.. c:function:: xo_handle_t *xo_create (xo_style_t style, xo_xof_flags_t flags) + + The `xo_create` function allocates a new handle which can be passed + to further libxo function calls. The `xo_handle_t` structure is + opaque. + + :param xo_style_t style: Output style (XO_STYLE\_*) + :param xo_xof_flags_t flags: Flags for this handle (XOF\_*) + :return: New libxo handle + :rtype: xo_handle_t \* + + :: + + EXAMPLE: + xo_handle_t *xop = xo_create(XO_STYLE_JSON, XOF_WARN | XOF_PRETTY); + .... + xo_emit_h(xop, "testing\n"); + + See also :ref:`output-styles` and :ref:`flags`. + +.. index:: xo_create_to_file +.. index:: XOF_CLOSE_FP + +xo_create_to_file +~~~~~~~~~~~~~~~~~ + +.. c:function:: + xo_handle_t *xo_create_to_file (FILE *fp, unsigned style, unsigned flags) + + The `xo_create_to_file` function is aconvenience function is + provided for situations when output should be written to a different + file, rather than the default of standard output. + + The `XOF_CLOSE_FP` flag can be set on the returned handle to trigger a + call to fclose() for the FILE pointer when the handle is destroyed, + avoiding the need for the caller to perform this task. + + :param fp: FILE to use as base for this handle + :type fp: FILE * + :param xo_style_t style: Output style (XO_STYLE\_*) + :param xo_xof_flags_t flags: Flags for this handle (XOF\_*) + :return: New libxo handle + :rtype: xo_handle_t \* + +.. index:: xo_set_writer +.. index:: xo_write_func_t +.. index:: xo_close_func_t +.. index:: xo_flush_func_t + +xo_set_writer +~~~~~~~~~~~~~ + +.. c:function:: + void xo_set_writer (xo_handle_t *xop, void *opaque, \ + xo_write_func_t write_func, xo_close_func_t close_func, \ + xo_flush_func_t flush_func) + + The `xo_set_writer` function allows custom functions which can + tailor how libxo writes data. The `opaque` argument is recorded and + passed back to the functions, allowing the function to acquire + context information. The *write_func* function writes data to the + output stream. The *close_func* function can release this opaque + data and any other resources as needed. The *flush_func* function + is called to flush buffered data associated with the opaque object. + + :param xop: Handle to modify (or NULL for default handle) + :type xop: xo_handle_t * + :param opaque: Pointer to opaque data passed to the given functions + :type opaque: void * + :param xo_write_func_t write_func: New write function + :param xo_close_func_t close_func: New close function + :param xo_flush_func_t flush_func: New flush function + :returns: void + +.. index:: xo_get_style + +xo_get_style +~~~~~~~~~~~~ + +.. c:function:: xo_style_t xo_get_style(xo_handle_t *xop) + + Use the `xo_get_style` function to find the current output style for + a given handle. To use the default handle, pass a `NULL` handle. + + :param xop: Handle to interrogate (or NULL for default handle) + :type xop: xo_handle_t * + :returns: Output style (XO_STYLE\_*) + :rtype: xo_style_t + + :: + + EXAMPLE:: + style = xo_get_style(NULL); + +.. index:: XO_STYLE_TEXT +.. index:: XO_STYLE_XML +.. index:: XO_STYLE_JSON +.. index:: XO_STYLE_HTML + +.. _output-styles: + +Output Styles (XO_STYLE\_\*) +++++++++++++++++++++++++++++ + +The libxo functions accept a set of output styles: + + =============== ========================= + Flag Description + =============== ========================= + XO_STYLE_TEXT Traditional text output + XO_STYLE_XML XML encoded data + XO_STYLE_JSON JSON encoded data + XO_STYLE_HTML HTML encoded data + =============== ========================= + +The "XML", "JSON", and "HTML" output styles all use the UTF-8 +character encoding. "TEXT" using locale-based encoding. + +.. index:: xo_set_style + +xo_set_style +~~~~~~~~~~~~ + +.. c:function:: void xo_set_style(xo_handle_t *xop, xo_style_t style) + + The `xo_set_style` function is used to change the output style + setting for a handle. To use the default handle, pass a `NULL` + handle. + + :param xop: Handle to modify + :type xop: xo_handle_t * + :param xo_style_t style: Output style (XO_STYLE\_*) + :returns: void + + :: + + EXAMPLE: + xo_set_style(NULL, XO_STYLE_XML); + +.. index:: xo_set_style_name + +xo_set_style_name +~~~~~~~~~~~~~~~~~ + +.. c:function:: int xo_set_style_name (xo_handle_t *xop, const char *style) + + The `xo_set_style_name` function can be used to set the style based + on a name encoded as a string: The name can be any of the supported + styles: "text", "xml", "json", or "html". + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param style: Text name of the style + :type style: const char \* + :returns: zero for success, non-zero for error + :rtype: int + + :: + + EXAMPLE: + xo_set_style_name(NULL, "html"); + +.. index:: xo_set_flags + +xo_set_flags +~~~~~~~~~~~~ + +.. c:function:: void xo_set_flags(xo_handle_t *xop, xo_xof_flags_t flags) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param xo_xof_flags_t flags: Flags to add for the handle + :returns: void + + Use the `xo_set_flags` function to turn on flags for a given libxo + handle. To use the default handle, pass a `NULL` handle. + + :: + + EXAMPLE: + xo_set_flags(NULL, XOF_PRETTY | XOF_WARN); + +.. index:: Flags; XOF_* +.. index:: XOF_CLOSE_FP +.. index:: XOF_COLOR +.. index:: XOF_COLOR_ALLOWED +.. index:: XOF_DTRT +.. index:: XOF_INFO +.. index:: XOF_KEYS +.. index:: XOF_NO_ENV +.. index:: XOF_NO_HUMANIZE +.. index:: XOF_PRETTY +.. index:: XOF_UNDERSCORES +.. index:: XOF_UNITS +.. index:: XOF_WARN +.. index:: XOF_WARN_XML +.. index:: XOF_XPATH +.. index:: XOF_COLUMNS +.. index:: XOF_FLUSH + +.. _flags: + +Flags (XOF\_\*) ++++++++++++++++ + +The set of valid flags include: + + =================== ========================================= + Flag Description + =================== ========================================= + XOF_CLOSE_FP Close file pointer on `xo_destroy` + XOF_COLOR Enable color and effects in output + XOF_COLOR_ALLOWED Allow color/effect for terminal output + XOF_DTRT Enable "do the right thing" mode + XOF_INFO Display info data attributes (HTML) + XOF_KEYS Emit the key attribute (XML) + XOF_NO_ENV Do not use the :ref:`libxo-options` env var + XOF_NO_HUMANIZE Display humanization (TEXT, HTML) + XOF_PRETTY Make "pretty printed" output + XOF_UNDERSCORES Replaces hyphens with underscores + XOF_UNITS Display units (XML, HMTL) + XOF_WARN Generate warnings for broken calls + XOF_WARN_XML Generate warnings in XML on stdout + XOF_XPATH Emit XPath expressions (HTML) + XOF_COLUMNS Force xo_emit to return columns used + XOF_FLUSH Flush output after each `xo_emit` call + =================== ========================================= + +The `XOF_CLOSE_FP` flag will trigger the call of the *close_func* +(provided via `xo_set_writer`) when the handle is destroyed. + +The `XOF_COLOR` flag enables color and effects in output regardless +of output device, while the `XOF_COLOR_ALLOWED` flag allows color +and effects only if the output device is a terminal. + +The `XOF_PRETTY` flag requests "pretty printing", which will trigger +the addition of indentation and newlines to enhance the readability of +XML, JSON, and HTML output. Text output is not affected. + +The `XOF_WARN` flag requests that warnings will trigger diagnostic +output (on standard error) when the library notices errors during +operations, or with arguments to functions. Without warnings enabled, +such conditions are ignored. + +Warnings allow developers to debug their interaction with libxo. +The function `xo_failure` can used as a breakpoint for a debugger, +regardless of whether warnings are enabled. + +If the style is `XO_STYLE_HTML`, the following additional flags can be +used: + + =============== ========================================= + Flag Description + =============== ========================================= + XOF_XPATH Emit "data-xpath" attributes + XOF_INFO Emit additional info fields + =============== ========================================= + +The `XOF_XPATH` flag enables the emission of XPath expressions detailing +the hierarchy of XML elements used to encode the data field, if the +XPATH style of output were requested. + +The `XOF_INFO` flag encodes additional informational fields for HTML +output. See :ref:`field-information` for details. + +If the style is `XO_STYLE_XML`, the following additional flags can be +used: + + =============== ========================================= + Flag Description + =============== ========================================= + XOF_KEYS Flag "key" fields for XML + =============== ========================================= + +The `XOF_KEYS` flag adds "key" attribute to the XML encoding for +field definitions that use the "k" modifier. The key attribute has +the value "key":: + + xo_emit("{k:name}", item); + + XML: + <name key="key">truck</name> + +.. index:: xo_clear_flags + +xo_clear_flags +++++++++++++++ + +.. c:function:: void xo_clear_flags (xo_handle_t *xop, xo_xof_flags_t flags) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param xo_xof_flags_t flags: Flags to clear for the handle + :returns: void + + Use the `xo_clear_flags` function to turn off the given flags in a + specific handle. To use the default handle, pass a `NULL` handle. + +.. index:: xo_set_options + +xo_set_options +++++++++++++++ + +.. c:function:: int xo_set_options (xo_handle_t *xop, const char *input) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param input: string containing options to set + :type input: const char * + :returns: zero for success, non-zero for error + :rtype: int + + The `xo_set_options` function accepts a comma-separated list of + output styles and modifier flags and enables them for a specific + handle. The options are identical to those listed in + :ref:`options`. To use the default handle, pass a `NULL` handle. + +.. index:: xo_destroy + +xo_destroy +++++++++++ + +.. c:function:: void xo_destroy(xo_handle_t *xop) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :returns: void + + The `xo_destroy` function releases a handle and any resources it is + using. Calling `xo_destroy` with a `NULL` handle will release any + resources associated with the default handle. + +.. index:: xo_emit + +Emitting Content (xo_emit) +-------------------------- + +The functions in this section are used to emit output. They use a +`format` string containing field descriptors as specified in +:ref:`format-strings`. The use of a handle is optional and `NULL` can +be passed to access the internal "default" handle. See +:ref:`handles`. + +The remaining arguments to `xo_emit` and `xo_emit_h` are a set of +arguments corresponding to the fields in the format string. Care must +be taken to ensure the argument types match the fields in the format +string, since an inappropriate or missing argument can ruin your day. +The `vap` argument to `xo_emit_hv` points to a variable argument list +that can be used to retrieve arguments via `va_arg`. + +.. c:function:: xo_ssize_t xo_emit (const char *fmt, ...) + + :param fmt: The format string, followed by zero or more arguments + :returns: If XOF_COLUMNS is set, the number of columns used; otherwise the number of bytes emitted + :rtype: xo_ssize_t + +.. c:function:: xo_ssize_t xo_emit_h (xo_handle_t *xop, const char *fmt, ...) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param fmt: The format string, followed by zero or more arguments + :returns: If XOF_COLUMNS is set, the number of columns used; otherwise the number of bytes emitted + :rtype: xo_ssize_t + +.. c:function:: xo_ssize_t xo_emit_hv (xo_handle_t *xop, const char *fmt, va_list vap) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param fmt: The format string + :param va_list vap: A set of variadic arguments + :returns: If XOF_COLUMNS is set, the number of columns used; otherwise the number of bytes emitted + :rtype: xo_ssize_t + +.. index:: xo_emit_field + +Single Field Emitting Functions (xo_emit_field) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The functions in this section emit formatted output similar to +`xo_emit` but where `xo_emit` uses a single string argument containing +the description for multiple fields, `xo_emit_field` emits a single +field using multiple ar- guments to contain the field description. +`xo_emit_field_h` adds an ex- plicit handle to use instead of the +default handle, while `xo_emit_field_hv` accepts a va_list for +additional flexibility. + +The arguments `rolmod`, `content`, `fmt`, and `efmt` are detailed in +:ref:`field-formatting`. Using distinct arguments allows callers to +pass the field description in pieces, rather than having to use +something like `snprintf` to build the format string required by +`xo_emit`. The arguments are each NUL-terminated strings. The `rolmod` +argument contains the `role` and `modifier` portions of the field +description, the `content` argument contains the `content` portion, and +the `fmt` and `efmt` contain the `field-format` and `encoding-format` por- +tions, respectively. + +As with `xo_emit`, the `fmt` and `efmt` values are both optional, +since the `field-format` string defaults to "%s", and the +`encoding-format`'s default value is derived from the `field-format` +per :ref:`field-formatting`. However, care must be taken to avoid +using a value directly as the format, since characters like '{', '%', +and '}' will be interpreted as formatting directives, and may cause +xo_emit_field to dereference arbitrary values off the stack, leading +to bugs, core files, and gnashing of teeth. + +.. c:function:: xo_ssize_t xo_emit_field (const char *rolmod, const char *content, const char *fmt, const char *efmt, ...) + + :param rolmod: A comma-separated list of field roles and field modifiers + :type rolmod: const char * + :param content: The "content" portion of the field description string + :type content: const char * + :param fmt: Contents format string + :type fmt: const char * + :param efmt: Encoding format string, followed by additional arguments + :type efmt: const char * + :returns: If XOF_COLUMNS is set, the number of columns used; otherwise the number of bytes emitted + :rtype: xo_ssize_t + + :: + + EXAMPLE:: + xo_emit_field("T", title, NULL, NULL, NULL); + xo_emit_field("T", "Host name is ", NULL, NULL); + xo_emit_field("V", "host-name", NULL, NULL, host-name); + xo_emit_field(",leaf-list,quotes", "sku", "%s-%u", "%s-000-%u", + "gum", 1412); + +.. c:function:: xo_ssize_t xo_emit_field_h (xo_handle_t *xop, const char *rolmod, const char *contents, const char *fmt, const char *efmt, ...) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param rolmod: A comma-separated list of field roles and field modifiers + :type rolmod: const char * + :param contents: The "contents" portion of the field description string + :type contents: const char * + :param fmt: Content format string + :type fmt: const char * + :param efmt: Encoding format string, followed by additional arguments + :type efmt: const char * + :returns: If XOF_COLUMNS is set, the number of columns used; otherwise the number of bytes emitted + :rtype: xo_ssize_t + +.. c:function:: xo_ssize_t xo_emit_field_hv (xo_handle_t *xop, const char *rolmod, const char *contents, const char *fmt, const char *efmt, va_list vap) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + :param rolmod: A comma-separated list of field roles and field modifiers + :type rolmod: const char * + :param contents: The "contents" portion of the field description string + :type contents: const char * + :param fmt: Content format string + :type fmt: const char * + :param efmt: Encoding format string + :type efmt: const char * + :param va_list vap: A set of variadic arguments + :returns: If XOF_COLUMNS is set, the number of columns used; otherwise the number of bytes emitted + :rtype: xo_ssize_t + +.. index:: xo_attr +.. _xo_attr: + +Attributes (xo_attr) +~~~~~~~~~~~~~~~~~~~~ + +The functions in this section emit an XML attribute with the given name +and value. This only affects the XML output style. + +The `name` parameter give the name of the attribute to be encoded. The +`fmt` parameter gives a printf-style format string used to format the +value of the attribute using any remaining arguments, or the vap +parameter passed to `xo_attr_hv`. + +All attributes recorded via `xo_attr` are placed on the next +container, instance, leaf, or leaf list that is emitted. + +Since attributes are only emitted in XML, their use should be limited +to meta-data and additional or redundant representations of data +already emitted in other form. + +.. c:function:: xo_ssize_t xo_attr (const char *name, const char *fmt, ...) + + :param name: Attribute name + :type name: const char * + :param fmt: Attribute value, as variadic arguments + :type fmt: const char * + :returns: -1 for error, or the number of bytes in the formatted attribute value + :rtype: xo_ssize_t + + :: + + EXAMPLE: + xo_attr("seconds", "%ld", (unsigned long) login_time); + struct tm *tmp = localtime(login_time); + strftime(buf, sizeof(buf), "%R", tmp); + xo_emit("Logged in at {:login-time}\n", buf); + XML: + <login-time seconds="1408336270">00:14</login-time> + + +.. c:function:: xo_ssize_t xo_attr_h (xo_handle_t *xop, const char *name, const char *fmt, ...) + + :param xop: Handle for modify (or NULL for default handle) + :type xop: xo_handle_t \* + + The `xo_attr_h` function follows the conventions of `xo_attr` but + adds an explicit libxo handle. + +.. c:function:: xo_ssize_t xo_attr_hv (xo_handle_t *xop, const char *name, const char *fmt, va_list vap) + + The `xo_attr_h` function follows the conventions of `xo_attr_h` + but replaced the variadic list with a variadic pointer. + +.. index:: xo_flush + +Flushing Output (xo_flush) +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. c:function:: xo_ssize_t xo_flush (void) + + :returns: -1 for error, or the number of bytes generated + :rtype: xo_ssize_t + + libxo buffers data, both for performance and consistency, but also + to allow for the proper function of various advanced features. At + various times, the caller may wish to flush any data buffered within + the library. The `xo_flush` call is used for this. + + Calling `xo_flush` also triggers the flush function associated with + the handle. For the default handle, this is equivalent to + "fflush(stdio);". + +.. c:function:: xo_ssize_t xo_flush_h (xo_handle_t *xop) + + :param xop: Handle for flush (or NULL for default handle) + :type xop: xo_handle_t \* + :returns: -1 for error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_flush_h` function follows the conventions of `xo_flush`, + but adds an explicit libxo handle. + +.. index:: xo_finish +.. index:: xo_finish_atexit +.. index:: atexit + +Finishing Output (xo_finish) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When the program is ready to exit or close a handle, a call to +`xo_finish` or `xo_finish_h` is required. This flushes any buffered +data, closes open libxo constructs, and completes any pending +operations. + +Calling this function is vital to the proper operation of libxo, +especially for the non-TEXT output styles. + +.. c:function:: xo_ssize_t xo_finish (void) + + :returns: -1 on error, or the number of bytes flushed + :rtype: xo_ssize_t + +.. c:function:: xo_ssize_t xo_finish_h (xo_handle_t *xop) + + :param xop: Handle for finish (or NULL for default handle) + :type xop: xo_handle_t \* + :returns: -1 on error, or the number of bytes flushed + :rtype: xo_ssize_t + +.. c:function:: void xo_finish_atexit (void) + + The `xo_finish_atexit` function is suitable for use with + :manpage:`atexit(3)` to ensure that `xo_finish` is called + on the default handle when the application exits. + +.. index:: UTF-8 +.. index:: xo_open_container +.. index:: xo_close_container + +Emitting Hierarchy +------------------ + +libxo represents two types of hierarchy: containers and lists. A +container appears once under a given parent where a list consists of +instances that can appear multiple times. A container is used to hold +related fields and to give the data organization and scope. + +.. index:: YANG + +.. admonition:: YANG Terminology + + libxo uses terminology from YANG (:RFC:`7950`), the data modeling + language for NETCONF: container, list, leaf, and leaf-list. + +For XML and JSON, individual fields appear inside hierarchies which +provide context and meaning to the fields. Unfortunately, these +encoding have a basic disconnect between how lists is similar objects +are represented. + +XML encodes lists as set of sequential elements:: + + <user>phil</user> + <user>pallavi</user> + <user>sjg</user> + +JSON encodes lists using a single name and square brackets:: + + "user": [ "phil", "pallavi", "sjg" ] + +This means libxo needs three distinct indications of hierarchy: one +for containers of hierarchy appear only once for any specific parent, +one for lists, and one for each item in a list. + +.. index:: Containers + +Containers +~~~~~~~~~~ + +A "*container*" is an element of a hierarchy that appears only once +under any specific parent. The container has no value, but serves to +contain and organize other nodes. + +To open a container, call xo_open_container() or +xo_open_container_h(). The former uses the default handle and the +latter accepts a specific handle. To close a level, use the +xo_close_container() or xo_close_container_h() functions. + +Each open call must have a matching close call. If the XOF_WARN flag +is set and the name given does not match the name of the currently open +container, a warning will be generated. + +.. c:function:: xo_ssize_t xo_open_container (const char *name) + + :param name: Name of the container + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `name` parameter gives the name of the container, encoded in + UTF-8. Since ASCII is a proper subset of UTF-8, traditional C + strings can be used directly. + +.. c:function:: xo_ssize_t xo_open_container_h (xo_handle_t *xop, const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_open_container_h` function adds a `handle` parameter. + +.. c:function:: xo_ssize_t xo_close_container (const char *name) + + :param name: Name of the container + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + +.. c:function:: xo_ssize_t xo_close_container_h (xo_handle_t *xop, const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_close_container_h` function adds a `handle` parameter. + +Use the :index:`XOF_WARN` flag to generate a warning if the name given +on the close does not match the current open container. + +For TEXT and HTML output, containers are not rendered into output +text, though for HTML they are used to record an XPath value when the +:index:`XOF_XPATH` flag is set. + +:: + + EXAMPLE: + xo_open_container("top"); + xo_open_container("system"); + xo_emit("{:host-name/%s%s%s}", hostname, + domainname ? "." : "", domainname ?: ""); + xo_close_container("system"); + xo_close_container("top"); + TEXT: + my-host.example.org + XML: + <top> + <system> + <host-name>my-host.example.org</host-name> + </system> + </top> + JSON: + "top" : { + "system" : { + "host-name": "my-host.example.org" + } + } + HTML: + <div class="data" + data-tag="host-name">my-host.example.org</div> + +.. index:: xo_open_instance +.. index:: xo_close_instance +.. index:: xo_open_list +.. index:: xo_close_list + +Lists and Instances +~~~~~~~~~~~~~~~~~~~ + +A "*list*" is set of one or more instances that appear under the same +parent. The instances contain details about a specific object. One +can think of instances as objects or records. A call is needed to +open and close the list, while a distinct call is needed to open and +close each instance of the list. + +The name given to all calls must be identical, and it is strongly +suggested that the name be singular, not plural, as a matter of +style and usage expectations:: + + EXAMPLE: + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + xo_emit("{L:Item} '{:name/%s}':\n", ip->i_title); + xo_close_instance("item"); + } + + xo_close_list("item"); + +Getting the list and instance calls correct is critical to the proper +generation of XML and JSON data. + +Opening Lists ++++++++++++++ + +.. c:function:: xo_ssize_t xo_open_list (const char *name) + + :param name: Name of the list + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_open_list` function open a list of instances. + +.. c:function:: xo_ssize_t xo_open_list_h (xo_handle_t *xop, const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + +Closing Lists ++++++++++++++ + +.. c:function:: xo_ssize_t xo_close_list (const char *name) + + :param name: Name of the list + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_close_list` function closes a list of instances. + +.. c:function:: xo_ssize_t xo_close_list_h (xo_handle_t *xop, const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_close_container_h` function adds a `handle` parameter. + +Opening Instances ++++++++++++++++++ + +.. c:function:: xo_ssize_t xo_open_instance (const char *name) + + :param name: Name of the instance (same as the list name) + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_open_instance` function open a single instance. + +.. c:function:: xo_ssize_t xo_open_instance_h (xo_handle_t *xop, const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_open_instance_h` function adds a `handle` parameter. + +Closing Instances ++++++++++++++++++ + +.. c:function:: xo_ssize_t xo_close_instance (const char *name) + + :param name: Name of the instance + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_close_instance` function closes an open instance. + +.. c:function:: xo_ssize_t xo_close_instance_h (xo_handle_t *xop, const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_close_instance_h` function adds a `handle` parameter. + + :: + + EXAMPLE: + xo_open_list("user"); + for (i = 0; i < num_users; i++) { + xo_open_instance("user"); + xo_emit("{k:name}:{:uid/%u}:{:gid/%u}:{:home}\n", + pw[i].pw_name, pw[i].pw_uid, + pw[i].pw_gid, pw[i].pw_dir); + xo_close_instance("user"); + } + xo_close_list("user"); + TEXT: + phil:1001:1001:/home/phil + pallavi:1002:1002:/home/pallavi + XML: + <user> + <name>phil</name> + <uid>1001</uid> + <gid>1001</gid> + <home>/home/phil</home> + </user> + <user> + <name>pallavi</name> + <uid>1002</uid> + <gid>1002</gid> + <home>/home/pallavi</home> + </user> + JSON: + user: [ + { + "name": "phil", + "uid": 1001, + "gid": 1001, + "home": "/home/phil", + }, + { + "name": "pallavi", + "uid": 1002, + "gid": 1002, + "home": "/home/pallavi", + } + ] + +Markers +~~~~~~~ + +Markers are used to protect and restore the state of open hierarchy +constructs (containers, lists, or instances). While a marker is open, +no other open constructs can be closed. When a marker is closed, all +constructs open since the marker was opened will be closed. + +Markers use names which are not user-visible, allowing the caller to +choose appropriate internal names. + +In this example, the code whiffles through a list of fish, calling a +function to emit details about each fish. The marker "fish-guts" is +used to ensure that any constructs opened by the function are closed +properly:: + + EXAMPLE: + for (i = 0; fish[i]; i++) { + xo_open_instance("fish"); + xo_open_marker("fish-guts"); + dump_fish_details(i); + xo_close_marker("fish-guts"); + } + +.. c:function:: xo_ssize_t xo_open_marker(const char *name) + + :param name: Name of the instance + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_open_marker` function records the current state of open tags + in order for `xo_close_marker` to close them at some later point. + +.. c:function:: xo_ssize_t xo_open_marker_h(const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_open_marker_h` function adds a `handle` parameter. + +.. c:function:: xo_ssize_t xo_close_marker(const char *name) + + :param name: Name of the instance + :type name: const char * + :returns: -1 on error, or the number of bytes generated + :rtype: xo_ssize_t + + The `xo_close_marker` function closes any open containers, lists, or + instances as needed to return to the state recorded when + `xo_open_marker` was called with the matching name. + +.. c:function:: xo_ssize_t xo_close_marker(const char *name) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_close_marker_h` function adds a `handle` parameter. + +DTRT Mode +~~~~~~~~~ + +Some users may find tracking the names of open containers, lists, and +instances inconvenient. libxo offers a "Do The Right Thing" mode, where +libxo will track the names of open containers, lists, and instances so +the close function can be called without a name. To enable DTRT mode, +turn on the XOF_DTRT flag prior to making any other libxo output:: + + xo_set_flags(NULL, XOF_DTRT); + +.. index:: XOF_DTRT + +Each open and close function has a version with the suffix "_d", which +will close the open container, list, or instance:: + + xo_open_container_d("top"); + ... + xo_close_container_d(); + +This also works for lists and instances:: + + xo_open_list_d("item"); + for (...) { + xo_open_instance_d("item"); + xo_emit(...); + xo_close_instance_d(); + } + xo_close_list_d(); + +.. index:: XOF_WARN + +Note that the XOF_WARN flag will also cause libxo to track open +containers, lists, and instances. A warning is generated when the +name given to the close function and the name recorded do not match. + +Support Functions +----------------- + +.. index:: xo_parse_args +.. _xo_parse_args: + +Parsing Command-line Arguments (xo_parse_args) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. c:function:: int xo_parse_args (int argc, char **argv) + + :param int argc: Number of arguments + :param argv: Array of argument strings + :return: -1 on error, or the number of remaining arguments + :rtype: int + + The `xo_parse_args` function is used to process a program's + arguments. libxo-specific options are processed and removed from + the argument list so the calling application does not need to + process them. If successful, a new value for argc is returned. On + failure, a message is emitted and -1 is returned:: + + argc = xo_parse_args(argc, argv); + if (argc < 0) + exit(EXIT_FAILURE); + + Following the call to xo_parse_args, the application can process the + remaining arguments in a normal manner. See :ref:`options` for a + description of valid arguments. + +.. index:: xo_set_program + +xo_set_program +~~~~~~~~~~~~~~ + +.. c:function:: void xo_set_program (const char *name) + + :param name: Name to use as the program name + :type name: const char * + :returns: void + + The `xo_set_program` function sets the name of the program as + reported by functions like `xo_failure`, `xo_warn`, `xo_err`, etc. + The program name is initialized by `xo_parse_args`, but subsequent + calls to `xo_set_program` can override this value:: + + EXAMPLE: + xo_set_program(argv[0]); + + Note that the value is not copied, so the memory passed to + `xo_set_program` (and `xo_parse_args`) must be maintained by the + caller. + +.. index:: xo_set_version + +xo_set_version +~~~~~~~~~~~~~~ + +.. c:function:: void xo_set_version (const char *version) + + :param name: Value to use as the version string + :type name: const char * + :returns: void + + The `xo_set_version` function records a version number to be emitted + as part of the data for encoding styles (XML and JSON). This + version number is suitable for tracking changes in the content, + allowing a user of the data to discern which version of the data + model is in use. + +.. c:function:: void xo_set_version_h (xo_handle_t *xop, const char *version) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + + The `xo_set_version` function adds a `handle` parameter. + +.. index:: --libxo +.. index:: XOF_INFO +.. index:: xo_info_t + +.. _field-information: + +Field Information (xo_info_t) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +HTML data can include additional information in attributes that +begin with "data-". To enable this, three things must occur: + +First the application must build an array of xo_info_t structures, +one per tag. The array must be sorted by name, since libxo uses a +binary search to find the entry that matches names from format +instructions. + +Second, the application must inform libxo about this information using +the `xo_set_info` call:: + + typedef struct xo_info_s { + const char *xi_name; /* Name of the element */ + const char *xi_type; /* Type of field */ + const char *xi_help; /* Description of field */ + } xo_info_t; + + void xo_set_info (xo_handle_t *xop, xo_info_t *infop, int count); + +Like other libxo calls, passing `NULL` for the handle tells libxo to +use the default handle. + +If the count is -1, libxo will count the elements of infop, but there +must be an empty element at the end. More typically, the number is +known to the application:: + + xo_info_t info[] = { + { "in-stock", "number", "Number of items in stock" }, + { "name", "string", "Name of the item" }, + { "on-order", "number", "Number of items on order" }, + { "sku", "string", "Stock Keeping Unit" }, + { "sold", "number", "Number of items sold" }, + }; + int info_count = (sizeof(info) / sizeof(info[0])); + ... + xo_set_info(NULL, info, info_count); + +Third, the emission of info must be triggered with the `XOF_INFO` flag +using either the `xo_set_flags` function or the "`--libxo=info`" +command line argument. + +The type and help values, if present, are emitted as the "data-type" +and "data-help" attributes:: + + <div class="data" data-tag="sku" data-type="string" + data-help="Stock Keeping Unit">GRO-000-533</div> + +.. c:function:: void xo_set_info (xo_handle_t *xop, xo_info_t *infop, int count) + + :param xop: Handle to use (or NULL for default handle) + :type xop: xo_handle_t * + :param infop: Array of information structures + :type infop: xo_info_t * + :returns: void + +.. index:: xo_set_allocator +.. index:: xo_realloc_func_t +.. index:: xo_free_func_t + +Memory Allocation +~~~~~~~~~~~~~~~~~ + +The `xo_set_allocator` function allows libxo to be used in +environments where the standard :manpage:`realloc(3)` and +:manpage:`free(3)` functions are not appropriate. + +.. c:function:: void xo_set_allocator (xo_realloc_func_t realloc_func, xo_free_func_t free_func) + + :param xo_realloc_func_t realloc_func: Allocation function + :param xo_free_func_t free_func: Free function + + *realloc_func* should expect the same arguments as + :manpage:`realloc(3)` and return a pointer to memory following the + same convention. *free_func* will receive the same argument as + :manpage:`free(3)` and should release it, as appropriate for the + environment. + +By default, the standard :manpage:`realloc(3)` and :manpage:`free(3)` +functions are used. + +.. index:: --libxo + +.. _libxo-options: + +LIBXO_OPTIONS +~~~~~~~~~~~~~ + +The environment variable "LIBXO_OPTIONS" can be set to a subset of +libxo options, including: + +- color +- flush +- flush-line +- no-color +- no-humanize +- no-locale +- no-retain +- pretty +- retain +- underscores +- warn + +For example, warnings can be enabled by:: + + % env LIBXO_OPTIONS=warn my-app + +Since environment variables are inherited, child processes will have +the same options, which may be undesirable, making the use of the +"`--libxo`" command-line option preferable in most situations. + +.. index:: xo_warn +.. index:: xo_err +.. index:: xo_errx +.. index:: xo_message + +Errors, Warnings, and Messages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Many programs make use of the standard library functions +:manpage:`err(3)` and :manpage:`warn(3)` to generate errors and +warnings for the user. libxo wants to pass that information via the +current output style, and provides compatible functions to allow +this:: + + void xo_warn (const char *fmt, ...); + void xo_warnx (const char *fmt, ...); + void xo_warn_c (int code, const char *fmt, ...); + void xo_warn_hc (xo_handle_t *xop, int code, + const char *fmt, ...); + void xo_err (int eval, const char *fmt, ...); + void xo_errc (int eval, int code, const char *fmt, ...); + void xo_errx (int eval, const char *fmt, ...); + +:: + + void xo_message (const char *fmt, ...); + void xo_message_c (int code, const char *fmt, ...); + void xo_message_hc (xo_handle_t *xop, int code, + const char *fmt, ...); + void xo_message_hcv (xo_handle_t *xop, int code, + const char *fmt, va_list vap); + +These functions display the program name, a colon, a formatted message +based on the arguments, and then optionally a colon and an error +message associated with either *errno* or the *code* parameter:: + + EXAMPLE: + if (open(filename, O_RDONLY) < 0) + xo_err(1, "cannot open file '%s'", filename); + +.. index:: xo_error +.. index:: xo_error_h +.. index:: xo_error_hv +.. index:: xo_errorn +.. index:: xo_errorn_h +.. index:: xo_errorn_hv + +xo_error +~~~~~~~~ + +.. c:function:: void xo_error (const char *fmt, ...) + + :param fmt: Format string + :type fmt: const char * + :returns: void + +.. c:function:: void xo_error_h (xo_handle_t *xop, const char *fmt, ...) + + :param xop: libxo handle pointer + :type xop: xo_handle_t * + :param fmt: Format string + :type fmt: const char * + :returns: void + +.. c:function:: void xo_error_hv (xo_handle_t *xop, const char *fmt, va_list vap) + + :param xop: libxo handle pointer + :type xop: xo_handle_t * + :param fmt: Format string + :type fmt: const char * + :param vap: variadic arguments + :type xop: va_list + :returns: void + +.. c:function:: void xo_errorn (const char *fmt, ...) + + :param fmt: Format string + :type fmt: const char * + :returns: void + +.. c:function:: void xo_errorn_h (xo_handle_t *xop, const char *fmt, ...) + + :param xop: libxo handle pointer + :type xop: xo_handle_t * + :param fmt: Format string + :type fmt: const char * + :returns: void + +.. c:function:: void xo_errorn_hv (xo_handle_t *xop, int need_newline, const char *fmt, va_list vap) + + :param xop: libxo handle pointer + :type xop: xo_handle_t * + :param need_newline: boolean indicating need for trailing newline + :type need_newline: int + :param fmt: Format string + :type fmt: const char * + :param vap: variadic arguments + :type xop: va_list + :returns: void + + The `xo_error` function can be used for generic errors that should + be reported over the handle, rather than to stderr. The `xo_error` + function behaves like `xo_err` for TEXT and HTML output styles, but + puts the error into XML or JSON elements:: + + EXAMPLE:: + xo_error("Does not %s", "compute"); + XML:: + <error><message>Does not compute</message></error> + JSON:: + "error": { "message": "Does not compute" } + + The `xo_error_h` and `xo_error_hv` add a handle object and a + variadic-ized parameter to the signature, respectively. + + The `xo_errorn` function supplies a newline at the end the error + message if the format string does not include one. The + `xo_errorn_h` and `xo_errorn_hv` functions add a handle object and + a variadic-ized parameter to the signature, respectively. The + `xo_errorn_hv` function also adds a boolean to indicate the need for + a trailing newline. + +.. index:: xo_no_setlocale +.. index:: Locale + +xo_no_setlocale +~~~~~~~~~~~~~~~ + +.. c:function:: void xo_no_setlocale (void) + + libxo automatically initializes the locale based on setting of the + environment variables LC_CTYPE, LANG, and LC_ALL. The first of this + list of variables is used and if none of the variables, the locale + defaults to "UTF-8". The caller may wish to avoid this behavior, + and can do so by calling the `xo_no_setlocale` function. + +Emitting syslog Messages +------------------------ + +syslog is the system logging facility used throughout the unix world. +Messages are sent from commands, applications, and daemons to a +hierarchy of servers, where they are filtered, saved, and forwarded +based on configuration behaviors. + +syslog is an older protocol, originally documented only in source +code. By the time :RFC:`3164` published, variation and mutation left the +leading "<pri>" string as only common content. :RFC:`5424` defines a new +version (version 1) of syslog and introduces structured data into the +messages. Structured data is a set of name/value pairs transmitted +distinctly alongside the traditional text message, allowing filtering +on precise values instead of regular expressions. + +These name/value pairs are scoped by a two-part identifier; an +enterprise identifier names the party responsible for the message +catalog and a name identifying that message. `Enterprise IDs`_ are +defined by IANA, the Internet Assigned Numbers Authority. + +.. _Enterprise IDs: + https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers + +Use the `xo_set_syslog_enterprise_id` function to set the Enterprise +ID, as needed. + +The message name should follow the conventions in +:ref:`good-field-names`\ , as should the fields within the message:: + + /* Both of these calls are optional */ + xo_set_syslog_enterprise_id(32473); + xo_open_log("my-program", 0, LOG_DAEMON); + + /* Generate a syslog message */ + xo_syslog(LOG_ERR, "upload-failed", + "error <%d> uploading file '{:filename}' " + "as '{:target/%s:%s}'", + code, filename, protocol, remote); + + xo_syslog(LOG_INFO, "poofd-invalid-state", + "state {:current/%u} is invalid {:connection/%u}", + state, conn); + +The developer should be aware that the message name may be used in the +future to allow access to further information, including +documentation. Care should be taken to choose quality, descriptive +names. + +.. _syslog-details: + +Priority, Facility, and Flags +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The `xo_syslog`, `xo_vsyslog`, and `xo_open_log` functions +accept a set of flags which provide the priority of the message, the +source facility, and some additional features. These values are OR'd +together to create a single integer argument:: + + xo_syslog(LOG_ERR | LOG_AUTH, "login-failed", + "Login failed; user '{:user}' from host '{:address}'", + user, addr); + +These values are defined in <syslog.h>. + +The priority value indicates the importance and potential impact of +each message: + + ============= ======================================================= + Priority Description + ============= ======================================================= + LOG_EMERG A panic condition, normally broadcast to all users + LOG_ALERT A condition that should be corrected immediately + LOG_CRIT Critical conditions + LOG_ERR Generic errors + LOG_WARNING Warning messages + LOG_NOTICE Non-error conditions that might need special handling + LOG_INFO Informational messages + LOG_DEBUG Developer-oriented messages + ============= ======================================================= + +The facility value indicates the source of message, in fairly generic +terms: + + =============== ======================================================= + Facility Description + =============== ======================================================= + LOG_AUTH The authorization system (e.g. :manpage:`login(1)`) + LOG_AUTHPRIV As LOG_AUTH, but logged to a privileged file + LOG_CRON The cron daemon: :manpage:`cron(8)` + LOG_DAEMON System daemons, not otherwise explicitly listed + LOG_FTP The file transfer protocol daemons + LOG_KERN Messages generated by the kernel + LOG_LPR The line printer spooling system + LOG_MAIL The mail system + LOG_NEWS The network news system + LOG_SECURITY Security subsystems, such as :manpage:`ipfw(4)` + LOG_SYSLOG Messages generated internally by :manpage:`syslogd(8)` + LOG_USER Messages generated by user processes (default) + LOG_UUCP The uucp system + LOG_LOCAL0..7 Reserved for local use + =============== ======================================================= + +In addition to the values listed above, xo_open_log accepts a set of +addition flags requesting specific logging behaviors: + + ============ ==================================================== + Flag Description + ============ ==================================================== + LOG_CONS If syslogd fails, attempt to write to /dev/console + LOG_NDELAY Open the connection to :manpage:`syslogd(8)` immediately + LOG_PERROR Write the message also to standard error output + LOG_PID Log the process id with each message + ============ ==================================================== + +.. index:: xo_syslog + +xo_syslog +~~~~~~~~~ + +.. c:function:: void xo_syslog (int pri, const char *name, const char *fmt, ...) + + :param int pri: syslog priority + :param name: Name of the syslog event + :type name: const char * + :param fmt: Format string, followed by arguments + :type fmt: const char * + :returns: void + + Use the `xo_syslog` function to generate syslog messages by calling + it with a log priority and facility, a message name, a format + string, and a set of arguments. The priority/facility argument are + discussed above, as is the message name. + + The format string follows the same conventions as `xo_emit`'s format + string, with each field being rendered as an SD-PARAM pair:: + + xo_syslog(LOG_ERR, "poofd-missing-file", + "'{:filename}' not found: {:error/%m}", filename); + + ... [poofd-missing-file@32473 filename="/etc/poofd.conf" + error="Permission denied"] '/etc/poofd.conf' not + found: Permission denied + +Support functions +~~~~~~~~~~~~~~~~~ + +.. index:: xo_vsyslog + +xo_vsyslog +++++++++++ + +.. c:function:: void xo_vsyslog (int pri, const char *name, const char *fmt, va_list vap) + + :param int pri: syslog priority + :param name: Name of the syslog event + :type name: const char * + :param fmt: Format string + :type fmt: const char * + :param va_list vap: Variadic argument list + :returns: void + + xo_vsyslog is identical in function to xo_syslog, but takes the set of + arguments using a va_list:: + + EXAMPLE: + void + my_log (const char *name, const char *fmt, ...) + { + va_list vap; + va_start(vap, fmt); + xo_vsyslog(LOG_ERR, name, fmt, vap); + va_end(vap); + } + +.. index:: xo_open_log + +xo_open_log ++++++++++++ + +.. c:function:: void xo_open_log (const char *ident, int logopt, int facility) + + :param indent: + :type indent: const char * + :param int logopt: Bit field containing logging options + :param int facility: + :returns: void + + xo_open_log functions similar to :manpage:`openlog(3)`, allowing + customization of the program name, the log facility number, and the + additional option flags described in :ref:`syslog-details`. + +.. index:: xo_close_log + +xo_close_log +++++++++++++ + +.. c:function:: void xo_close_log (void) + + The `xo_close_log` function is similar to :manpage:`closelog(3)`, + closing the log file and releasing any associated resources. + +.. index:: xo_set_logmask + +xo_set_logmask +++++++++++++++ + +.. c:function:: int xo_set_logmask (int maskpri) + + :param int maskpri: the log priority mask + :returns: The previous log priority mask + + The `xo_set_logmask` function is similar to :manpage:`setlogmask(3)`, + restricting the set of generated log event to those whose associated + bit is set in maskpri. Use `LOG_MASK(pri)` to find the appropriate bit, + or `LOG_UPTO(toppri)` to create a mask for all priorities up to and + including toppri:: + + EXAMPLE: + setlogmask(LOG_UPTO(LOG_WARN)); + +.. index:: xo_set_syslog_enterprise_id + +xo_set_syslog_enterprise_id ++++++++++++++++++++++++++++ + +.. c:function:: void xo_set_syslog_enterprise_id (unsigned short eid) + + Use the `xo_set_syslog_enterprise_id` to supply a platform- or + application-specific enterprise id. This value is used in any future + syslog messages. + + Ideally, the operating system should supply a default value via the + "kern.syslog.enterprise_id" sysctl value. Lacking that, the + application should provide a suitable value. + +Enterprise IDs are administered by IANA, the Internet Assigned Number +Authority. The complete list is EIDs on their web site:: + + https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers + +New EIDs can be requested from IANA using the following page:: + + http://pen.iana.org/pen/PenApplication.page + +Each software development organization that defines a set of syslog +messages should register their own EID and use that value in their +software to ensure that messages can be uniquely identified by the +combination of EID + message name. + +Creating Custom Encoders +------------------------ + +The number of encoding schemes in current use is staggering, with new +and distinct schemes appearing daily. While libxo provide XML, JSON, +HMTL, and text natively, there are requirements for other encodings. + +Rather than bake support for all possible encoders into libxo, the API +allows them to be defined externally. libxo can then interfaces with +these encoding modules using a simplistic API. libxo processes all +functions calls, handles state transitions, performs all formatting, +and then passes the results as operations to a customized encoding +function, which implements specific encoding logic as required. This +means your encoder doesn't need to detect errors with unbalanced +open/close operations but can rely on libxo to pass correct data. + +By making a simple API, libxo internals are not exposed, insulating the +encoder and the library from future or internal changes. + +The three elements of the API are: + +- loading +- initialization +- operations + +The following sections provide details about these topics. + +.. index:: CBOR + +libxo source contains an encoder for Concise Binary Object +Representation, aka CBOR (:RFC:`7049`), which can be used as an +example for the API for other encoders. + +Loading Encoders +~~~~~~~~~~~~~~~~ + +Encoders can be registered statically or discovered dynamically. +Applications can choose to call the `xo_encoder_register` function +to explicitly register encoders, but more typically they are built as +shared libraries, placed in the libxo/extensions directory, and loaded +based on name. libxo looks for a file with the name of the encoder +and an extension of ".enc". This can be a file or a symlink to the +shared library file that supports the encoder:: + + % ls -1 lib/libxo/extensions/*.enc + lib/libxo/extensions/cbor.enc + lib/libxo/extensions/test.enc + +Encoder Initialization +~~~~~~~~~~~~~~~~~~~~~~ + +Each encoder must export a symbol used to access the library, which +must have the following signature:: + + int xo_encoder_library_init (XO_ENCODER_INIT_ARGS); + +`XO_ENCODER_INIT_ARGS` is a macro defined in "xo_encoder.h" that defines +an argument called "arg", a pointer of the type +`xo_encoder_init_args_t`. This structure contains two fields: + +- `xei_version` is the version number of the API as implemented + within libxo. This version is currently as 1 using + `XO_ENCODER_VERSION`. This number can be checked to ensure + compatibility. The working assumption is that all versions should + be backward compatible, but each side may need to accurately know + the version supported by the other side. `xo_encoder_library_init` + can optionally check this value, and must then set it to the version + number used by the encoder, allowing libxo to detect version + differences and react accordingly. For example, if version 2 adds + new operations, then libxo will know that an encoding library that + set `xei_version` to 1 cannot be expected to handle those new + operations. + +- xei_handler must be set to a pointer to a function of type + `xo_encoder_func_t`, as defined in "xo_encoder.h". This function + takes a set of parameters: + - xop is a pointer to the opaque `xo_handle_t` structure + - op is an integer representing the current operation + - name is a string whose meaning differs by operation + - value is a string whose meaning differs by operation + - private is an opaque structure provided by the encoder + +Additional arguments may be added in the future, so handler functions +should use the `XO_ENCODER_HANDLER_ARGS` macro. An appropriate +"extern" declaration is provided to help catch errors. + +Once the encoder initialization function has completed processing, it +should return zero to indicate that no error has occurred. A non-zero +return code will cause the handle initialization to fail. + +Operations +~~~~~~~~~~ + +The encoder API defines a set of operations representing the +processing model of libxo. Content is formatted within libxo, and +callbacks are made to the encoder's handler function when data is +ready to be processed: + + ======================= ======================================= + Operation Meaning (Base function) + ======================= ======================================= + XO_OP_CREATE Called when the handle is created + XO_OP_OPEN_CONTAINER Container opened (xo_open_container) + XO_OP_CLOSE_CONTAINER Container closed (xo_close_container) + XO_OP_OPEN_LIST List opened (xo_open_list) + XO_OP_CLOSE_LIST List closed (xo_close_list) + XO_OP_OPEN_LEAF_LIST Leaf list opened (xo_open_leaf_list) + XO_OP_CLOSE_LEAF_LIST Leaf list closed (xo_close_leaf_list) + XO_OP_OPEN_INSTANCE Instance opened (xo_open_instance) + XO_OP_CLOSE_INSTANCE Instance closed (xo_close_instance) + XO_OP_STRING Field with Quoted UTF-8 string + XO_OP_CONTENT Field with content + XO_OP_FINISH Finish any pending output + XO_OP_FLUSH Flush any buffered output + XO_OP_DESTROY Clean up resources + XO_OP_ATTRIBUTE An attribute name/value pair + XO_OP_VERSION A version string + ======================= ======================================= + +For all the open and close operations, the name parameter holds the +name of the construct. For string, content, and attribute operations, +the name parameter is the name of the field and the value parameter is +the value. "string" are differentiated from "content" to allow differing +treatment of true, false, null, and numbers from real strings, though +content values are formatted as strings before the handler is called. +For version operations, the value parameter contains the version. + +All strings are encoded in UTF-8. diff --git a/contrib/libxo/doc/conf.py b/contrib/libxo/doc/conf.py new file mode 100644 index 000000000000..62935cf4e43d --- /dev/null +++ b/contrib/libxo/doc/conf.py @@ -0,0 +1,186 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# JuniperStory documentation build configuration file, created by +# sphinx-quickstart on Tue Oct 10 10:18:55 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import subprocess + +# +# Instead of hardcoding the version number here, we read it from the +# project's configure script +# +vers_cmd = "grep AC_INIT ../configure.ac | awk '{ print substr($2, 2, length($2) - 3);}'" +version = subprocess.check_output(vers_cmd, shell=True).decode("utf-8") + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'libxo' +copyright = '2017-2019, Juniper Networks Inc' +author = 'Phil Shafer' +default_role = 'code' +primary_domain = 'c' +smart_quotes = False + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +#version = 'develop' +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinxdoc' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} +html_theme_options = { + "sidebarwidth": 320, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +alabaster_html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'libxo-manual' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'libxo.tex', 'libxo Documentation', + 'Phil Shafer', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'libxo', 'libxo Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'libxo', 'libxo Documentation', + author, 'libxo', 'A Library for Generating Text, XML, JSON, and HTML Output', + 'Miscellaneous'), +] + + + diff --git a/contrib/libxo/doc/encoders.rst b/contrib/libxo/doc/encoders.rst new file mode 100644 index 000000000000..dfd0316bfb97 --- /dev/null +++ b/contrib/libxo/doc/encoders.rst @@ -0,0 +1,274 @@ +.. index:: encoder + +Encoders +======== + +This section gives an overview of encoders, details on the encoders +that ship with libxo, and documentation for developers of future +encoders. + +Overview +-------- + +The libxo library contains software to generate four "built-in" +formats: text, XML, JSON, and HTML. These formats are common and +useful, but there are other common and useful formats that users will +want, and including them all in the libxo software would be difficult +and cumbersome. + +To allow support for additional encodings, libxo includes a +"pluggable" extension mechanism for dynamically loading new encoders. +libxo-based applications can automatically use any installed encoder. + +Use the "encoder=XXX" option to access encoders. The following +example uses the "cbor" encoder, saving the output into a file:: + + df --libxo encoder=cbor > df-output.cbor + +Encoders can support specific options that can be accessed by +following the encoder name with a colon (':') or a plus sign ('+') and +one of more options, separated by the same character:: + + df --libxo encoder=csv+path=filesystem+leaf=name+no-header + df --libxo encoder=csv:path=filesystem:leaf=name:no-header + +These examples instructs libxo to load the "csv" encoder and pass the +following options:: + + path=filesystem + leaf=name + no-header + +Each of these option is interpreted by the encoder, and all such +options names and semantics are specific to the particular encoder. +Refer to the intended encoder for documentation on its options. + +The string "@" can be used in place of the string "encoder=". + + df --libxo @csv:no-header + +.. _csv_encoder: + +CSV - Comma Separated Values +---------------------------- + +libxo ships with a custom encoder for "CSV" files, a common format for +comma separated values. The output of the CSV encoder can be loaded +directly into spreadsheets or similar applications. + +A standard for CSV files is provided in :RFC:`4180`, but since the +format predates that standard by decades, there are many minor +differences in CSV file consumers and their expectations. The CSV +encoder has a number of options to tailor output to those +expectations. + +Consider the following XML:: + + % list-items --libxo xml,pretty + <top> + <data test="value"> + <item test2="value2"> + <sku test3="value3" key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + </item> + </data> + </top> + +This output is a list of `instances` (named "item"), each containing a +set of `leafs` ("sku", "name", etc). + +The CSV encoder will emit the leaf values in this output as `fields` +inside a CSV `record`, which is a line containing a set of +comma-separated values:: + + % list-items --libxo encoder=csv + sku,name,sold,in-stock,on-order + GRO-000-415,gum,1412,54,10 + HRD-000-212,rope,85,4,2 + HRD-000-517,ladder,0,2,1 + +Be aware that since the CSV encoder looks for data instances, when +used with :ref:`xo`, the `--instance` option will be needed:: + + % xo --libxo encoder=csv --instance foo 'The {:product} is {:status}\n' stereo "in route" + product,status + stereo,in route + +.. _csv_path: + +The `path` Option +~~~~~~~~~~~~~~~~~ + +By default, the CSV encoder will attempt to emit any list instance +generated by the application. In some cases, this may be +unacceptable, and a specific list may be desired. + +Use the "path" option to limit the processing of output to a specific +hierarchy. The path should be one or more names of containers or +lists. + +For example, if the "list-items" application generates other lists, +the user can give "path=top/data/item" as a path:: + + % list-items --libxo encoder=csv:path=top/data/item + sku,name,sold,in-stock,on-order + GRO-000-415,gum,1412,54,10 + HRD-000-212,rope,85,4,2 + HRD-000-517,ladder,0,2,1 + +Paths are "relative", meaning they need not be a complete set +of names to the list. This means that "path=item" may be sufficient +for the above example. + +.. _csv_leafs: + +The `leafs` Option +~~~~~~~~~~~~~~~~~~ + +The CSV encoding requires that all lines of output have the same +number of fields with the same order. In contrast, XML and JSON allow +any order (though libxo forces key leafs to appear before other +leafs). + +To maintain a consistent set of fields inside the CSV file, the same +set of leafs must be selected from each list item. By default, the +CSV encoder records the set of leafs that appear in the first list +instance it processes, and extract only those leafs from future +instances. If the first instance is missing a leaf that is desired by +the consumer, the "leaf" option can be used to ensure that an empty +value is recorded for instances that lack a particular leaf. + +The "leafs" option can also be used to exclude leafs, limiting the +output to only those leafs provided. + +In addition, the order of the output fields follows the order in which +the leafs are listed. "leafs=one.two" and "leafs=two.one" give +distinct output. + +So the "leafs" option can be used to expand, limit, and order the set +of leafs. + +The value of the leafs option should be one or more leaf names, +separated by a period ("."):: + + % list-items --libxo encoder=csv:leafs=sku.on-order + sku,on-order + GRO-000-415,10 + HRD-000-212,2 + HRD-000-517,1 + % list-items -libxo encoder=csv:leafs=on-order.sku + on-order,sku + 10,GRO-000-415 + 2,HRD-000-212 + 1,HRD-000-517 + +Note that since libxo uses terminology from YANG (:RFC:`7950`), the +data modeling language for NETCONF (:RFC:`6241`), which uses "leafs" +as the plural form of "leaf". libxo follows that convention. + +.. _csv_no_header: + +The `no-header` Option +~~~~~~~~~~~~~~~~~~~~~~ + +CSV files typical begin with a line that defines the fields included +in that file, in an attempt to make the contents self-defining:: + + sku,name,sold,in-stock,on-order + GRO-000-415,gum,1412,54,10 + HRD-000-212,rope,85,4,2 + HRD-000-517,ladder,0,2,1 + +There is no reliable mechanism for determining whether this header +line is included, so the consumer must make an assumption. + +The csv encoder defaults to producing the header line, but the +"no-header" option can be included to avoid the header line. + +.. _csv_no_quotes: + +The `no-quotes` Option +~~~~~~~~~~~~~~~~~~~~~~ + +:RFC:`4180` specifies that fields containing spaces should be quoted, but +many CSV consumers do not handle quotes. The "no-quotes" option +instruct the CSV encoder to avoid the use of quotes. + +.. _csv_dos: + +The `dos` Option +~~~~~~~~~~~~~~~~ + +:RFC:`4180` defines the end-of-line marker as a carriage return +followed by a newline. This `CRLF` convention dates from the distant +past, but its use was anchored in the 1980s by the `DOS` operating +system. + +The CSV encoder defaults to using the standard Unix end-of-line +marker, a simple newline. Use the "dos" option to use the `CRLF` +convention. + +The Encoder API +--------------- + +The encoder API consists of three distinct phases: + +- loading the encoder +- initializing the encoder +- feeding operations to the encoder + +To load the encoder, libxo will open a shared library named: + + ${prefix}/lib/libxo/encoder/${name}.enc + +This file is typically a symbolic link to a dynamic library, suitable +for `dlopen`(). libxo looks for a symbol called +`xo_encoder_library_init` inside that library and calls it with the +arguments defined in the header file "xo_encoder.h". This function +should look as follows:: + + int + xo_encoder_library_init (XO_ENCODER_INIT_ARGS) + { + arg->xei_version = XO_ENCODER_VERSION; + arg->xei_handler = test_handler; + + return 0; + } + +Several features here allow for future compatibility: the macro +XO_ENCODER_INIT_ARGS allows the arguments to this function change over +time, and the XO_ENCODER_VERSION allows the library to tell libxo +which version of the API it was compiled with. + +The function places in xei_handler should be have the signature:: + + static int + test_handler (XO_ENCODER_HANDLER_ARGS) + { + ... + +This function will be called with the "op" codes defined in +"xo_encoder.h". Each op code represents a distinct event in the libxo +processing model. For example OP_OPEN_CONTAINER tells the encoder +that a new container has been opened, and the encoder can behave in an +appropriate manner. + + diff --git a/contrib/libxo/doc/example.rst b/contrib/libxo/doc/example.rst new file mode 100644 index 000000000000..2975ddeb1b59 --- /dev/null +++ b/contrib/libxo/doc/example.rst @@ -0,0 +1,694 @@ + +Examples +======== + +Unit Test +--------- + +Here is one of the unit tests as an example:: + + int + main (int argc, char **argv) + { + static char base_grocery[] = "GRO"; + static char base_hardware[] = "HRD"; + struct item { + const char *i_title; + int i_sold; + int i_instock; + int i_onorder; + const char *i_sku_base; + int i_sku_num; + }; + struct item list[] = { + { "gum", 1412, 54, 10, base_grocery, 415 }, + { "rope", 85, 4, 2, base_hardware, 212 }, + { "ladder", 0, 2, 1, base_hardware, 517 }, + { "bolt", 4123, 144, 42, base_hardware, 632 }, + { "water", 17, 14, 2, base_grocery, 2331 }, + { NULL, 0, 0, 0, NULL, 0 } + }; + struct item list2[] = { + { "fish", 1321, 45, 1, base_grocery, 533 }, + }; + struct item *ip; + xo_info_t info[] = { + { "in-stock", "number", "Number of items in stock" }, + { "name", "string", "Name of the item" }, + { "on-order", "number", "Number of items on order" }, + { "sku", "string", "Stock Keeping Unit" }, + { "sold", "number", "Number of items sold" }, + { NULL, NULL, NULL }, + }; + int info_count = (sizeof(info) / sizeof(info[0])) - 1; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + exit(EXIT_FAILURE); + + xo_set_info(NULL, info, info_count); + + xo_open_container_h(NULL, "top"); + + xo_open_container("data"); + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{L:Item} '{k:name/%s}':\n", ip->i_title); + xo_emit("{P: }{L:Total sold}: {n:sold/%u%s}\n", + ip->i_sold, ip->i_sold ? ".0" : ""); + xo_emit("{P: }{Lwc:In stock}{:in-stock/%u}\n", + ip->i_instock); + xo_emit("{P: }{Lwc:On order}{:on-order/%u}\n", + ip->i_onorder); + xo_emit("{P: }{L:SKU}: {q:sku/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_open_container("data"); + xo_open_list("item"); + + for (ip = list2; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{L:Item} '{:name/%s}':\n", ip->i_title); + xo_emit("{P: }{L:Total sold}: {n:sold/%u%s}\n", + ip->i_sold, ip->i_sold ? ".0" : ""); + xo_emit("{P: }{Lwc:In stock}{:in-stock/%u}\n", + ip->i_instock); + xo_emit("{P: }{Lwc:On order}{:on-order/%u}\n", + ip->i_onorder); + xo_emit("{P: }{L:SKU}: {q:sku/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_close_container_h(NULL, "top"); + + return 0; + } + +Text output:: + + % ./testxo --libxo text + Item 'gum': + Total sold: 1412.0 + In stock: 54 + On order: 10 + SKU: GRO-000-415 + Item 'rope': + Total sold: 85.0 + In stock: 4 + On order: 2 + SKU: HRD-000-212 + Item 'ladder': + Total sold: 0 + In stock: 2 + On order: 1 + SKU: HRD-000-517 + Item 'bolt': + Total sold: 4123.0 + In stock: 144 + On order: 42 + SKU: HRD-000-632 + Item 'water': + Total sold: 17.0 + In stock: 14 + On order: 2 + SKU: GRO-000-2331 + Item 'fish': + Total sold: 1321.0 + In stock: 45 + On order: 1 + SKU: GRO-000-533 + +JSON output:: + + % ./testxo --libxo json,pretty + "top": { + "data": { + "item": [ + { + "name": "gum", + "sold": 1412.0, + "in-stock": 54, + "on-order": 10, + "sku": "GRO-000-415" + }, + { + "name": "rope", + "sold": 85.0, + "in-stock": 4, + "on-order": 2, + "sku": "HRD-000-212" + }, + { + "name": "ladder", + "sold": 0, + "in-stock": 2, + "on-order": 1, + "sku": "HRD-000-517" + }, + { + "name": "bolt", + "sold": 4123.0, + "in-stock": 144, + "on-order": 42, + "sku": "HRD-000-632" + }, + { + "name": "water", + "sold": 17.0, + "in-stock": 14, + "on-order": 2, + "sku": "GRO-000-2331" + } + ] + }, + "data": { + "item": [ + { + "name": "fish", + "sold": 1321.0, + "in-stock": 45, + "on-order": 1, + "sku": "GRO-000-533" + } + ] + } + } + +XML output:: + + % ./testxo --libxo pretty,xml + <top> + <data> + <item> + <name>gum</name> + <sold>1412.0</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + <sku>GRO-000-415</sku> + </item> + <item> + <name>rope</name> + <sold>85.0</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + <sku>HRD-000-212</sku> + </item> + <item> + <name>ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + <sku>HRD-000-517</sku> + </item> + <item> + <name>bolt</name> + <sold>4123.0</sold> + <in-stock>144</in-stock> + <on-order>42</on-order> + <sku>HRD-000-632</sku> + </item> + <item> + <name>water</name> + <sold>17.0</sold> + <in-stock>14</in-stock> + <on-order>2</on-order> + <sku>GRO-000-2331</sku> + </item> + </data> + <data> + <item> + <name>fish</name> + <sold>1321.0</sold> + <in-stock>45</in-stock> + <on-order>1</on-order> + <sku>GRO-000-533</sku> + </item> + </data> + </top> + +HMTL output:: + + % ./testxo --libxo pretty,html + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name">gum</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">1412.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">54</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">10</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku">GRO-000-415</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name">rope</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">85.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">4</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">2</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku">HRD-000-212</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name">ladder</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">2</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">1</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku">HRD-000-517</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name">bolt</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">4123.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">144</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">42</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku">HRD-000-632</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name">water</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">17.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">14</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">2</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku">GRO-000-2331</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name">fish</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">1321.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">45</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">1</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku">GRO-000-533</div> + </div> + +HTML output with xpath and info flags:: + + % ./testxo --libxo pretty,html,xpath,info + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" + data-xpath="/top/data/item/name" data-type="string" + data-help="Name of the item">gum</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" + data-xpath="/top/data/item/sold" data-type="number" + data-help="Number of items sold">1412.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" data-type="number" + data-help="Number of items in stock">54</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" + data-xpath="/top/data/item/on-order" data-type="number" + data-help="Number of items on order">10</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" + data-xpath="/top/data/item/sku" data-type="string" + data-help="Stock Keeping Unit">GRO-000-415</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" + data-xpath="/top/data/item/name" data-type="string" + data-help="Name of the item">rope</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" + data-xpath="/top/data/item/sold" data-type="number" + data-help="Number of items sold">85.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" data-type="number" + data-help="Number of items in stock">4</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" + data-xpath="/top/data/item/on-order" data-type="number" + data-help="Number of items on order">2</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" + data-xpath="/top/data/item/sku" data-type="string" + data-help="Stock Keeping Unit">HRD-000-212</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" + data-xpath="/top/data/item/name" data-type="string" + data-help="Name of the item">ladder</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" + data-xpath="/top/data/item/sold" data-type="number" + data-help="Number of items sold">0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" data-type="number" + data-help="Number of items in stock">2</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" + data-xpath="/top/data/item/on-order" data-type="number" + data-help="Number of items on order">1</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" + data-xpath="/top/data/item/sku" data-type="string" + data-help="Stock Keeping Unit">HRD-000-517</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" + data-xpath="/top/data/item/name" data-type="string" + data-help="Name of the item">bolt</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" + data-xpath="/top/data/item/sold" data-type="number" + data-help="Number of items sold">4123.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" data-type="number" + data-help="Number of items in stock">144</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" + data-xpath="/top/data/item/on-order" data-type="number" + data-help="Number of items on order">42</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" + data-xpath="/top/data/item/sku" data-type="string" + data-help="Stock Keeping Unit">HRD-000-632</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" + data-xpath="/top/data/item/name" data-type="string" + data-help="Name of the item">water</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" + data-xpath="/top/data/item/sold" data-type="number" + data-help="Number of items sold">17.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" data-type="number" + data-help="Number of items in stock">14</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" + data-xpath="/top/data/item/on-order" data-type="number" + data-help="Number of items on order">2</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" + data-xpath="/top/data/item/sku" data-type="string" + data-help="Stock Keeping Unit">GRO-000-2331</div> + </div> + <div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" + data-xpath="/top/data/item/name" data-type="string" + data-help="Name of the item">fish</div> + <div class="text">':</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" + data-xpath="/top/data/item/sold" data-type="number" + data-help="Number of items sold">1321.0</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" data-type="number" + data-help="Number of items in stock">45</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" + data-xpath="/top/data/item/on-order" data-type="number" + data-help="Number of items on order">1</div> + </div> + <div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" + data-xpath="/top/data/item/sku" data-type="string" + data-help="Stock Keeping Unit">GRO-000-533</div> + </div> diff --git a/contrib/libxo/doc/faq.rst b/contrib/libxo/doc/faq.rst new file mode 100644 index 000000000000..5232a7271681 --- /dev/null +++ b/contrib/libxo/doc/faq.rst @@ -0,0 +1,211 @@ + +FAQs +==== + +This section contains the set of questions that users typically ask, +along with answers that might be helpful. + +General +------- + +Can you share the history of libxo? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In 2001, we added an XML API to the JUNOS operating system, which is +built on top of FreeBSD_. Eventually this API became standardized as +the NETCONF API (:RFC:`6241`). As part of this effort, we modified many +FreeBSD utilities to emit XML, typically via a "-X" switch. The +results were mixed. The cost of maintaining this code, updating it, +and carrying it were non-trivial, and contributed to our expense (and +the associated delay) with upgrading the version of FreeBSD on which +each release of JUNOS is based. + +.. _FreeBSD: https://www.freebsd.org + +A recent (2014) effort within JUNOS aims at removing our modifications +to the underlying FreeBSD code as a means of reducing the expense and +delay in tracking HEAD. JUNOS is structured to have system components +generate XML that is rendered by the CLI (think: login shell) into +human-readable text. This allows the API to use the same plumbing as +the CLI, and ensures that all components emit XML, and that it is +emitted with knowledge of the consumer of that XML, yielding an API +that have no incremental cost or feature delay. + +libxo is an effort to mix the best aspects of the JUNOS strategy into +FreeBSD in a seemless way, allowing commands to make printf-like +output calls with a single code path. + +Did the complex semantics of format strings evolve over time? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The history is both long and short: libxo's functionality is based +on what JUNOS does in a data modeling language called ODL (output +definition language). In JUNOS, all subcomponents generate XML, +which is feed to the CLI, where data from the ODL files tell is +how to render that XML into text. ODL might had a set of tags +like:: + + tag docsis-state { + help "State of the DOCSIS interface"; + type string; + } + + tag docsis-mode { + help "DOCSIS mode (2.0/3.0) of the DOCSIS interface"; + type string; + } + + tag docsis-upstream-speed { + help "Operational upstream speed of the interface"; + type string; + } + + tag downstream-scanning { + help "Result of scanning in downstream direction"; + type string; + } + + tag ranging { + help "Result of ranging action"; + type string; + } + + tag signal-to-noise-ratio { + help "Signal to noise ratio for all channels"; + type string; + } + + tag power { + help "Operational power of the signal on all channels"; + type string; + } + + format docsis-status-format { + picture " + State : @, Mode: @, Upstream speed: @ + Downstream scanning: @, Ranging: @ + Signal to noise ratio: @ + Power: @ + "; + line { + field docsis-state; + field docsis-mode; + field docsis-upstream-speed; + field downstream-scanning; + field ranging; + field signal-to-noise-ratio; + field power; + } + } + +These tag definitions are compiled into field definitions +that are triggered when matching XML elements are seen. ODL +also supports other means of defining output. + +The roles and modifiers describe these details. + +In moving these ideas to bsd, two things had to happen: the +formatting had to happen at the source since BSD won't have +a JUNOS-like CLI to do the rendering, and we can't depend on +external data models like ODL, which was seen as too hard a +sell to the BSD community. + +The results were that the xo_emit strings are used to encode the +roles, modifiers, names, and formats. They are dense and a bit +cryptic, but not so unlike printf format strings that developers will +be lost. + +libxo is a new implementation of these ideas and is distinct from +the previous implementation in JUNOS. + +.. index:: XOF_UNDERSCORES + +.. _good-field-names: + +What makes a good field name? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To make useful, consistent field names, follow these guidelines: + +Use lower case, even for TLAs + Lower case is more civilized. Even TLAs should be lower case + to avoid scenarios where the differences between "XPath" and + "Xpath" drive your users crazy. Using "xpath" is simpler and better. + +Use hyphens, not underscores + Use of hyphens is traditional in XML, and the XOF_UNDERSCORES + flag can be used to generate underscores in JSON, if desired. + But the raw field name should use hyphens. + +Use full words + Don't abbreviate especially when the abbreviation is not obvious or + not widely used. Use "data-size", not "dsz" or "dsize". Use + "interface" instead of "ifname", "if-name", "iface", "if", or "intf". + +Use <verb>-<units> + Using the form <verb>-<units> or <verb>-<classifier>-<units> helps in + making consistent, useful names, avoiding the situation where one app + uses "sent-packet" and another "packets-sent" and another + "packets-we-have-sent". The <units> can be dropped when it is + obvious, as can obvious words in the classification. + Use "receive-after-window-packets" instead of + "received-packets-of-data-after-window". + +Reuse existing field names + Nothing's worse than writing expressions like:: + + if ($src1/process[pid == $pid]/name == + $src2/proc-table/proc-list + /prc-entry[prcss-id == $pid]/proc-name) { + ... + } + + Find someone else who is expressing similar data and follow their + fields and hierarchy. Remember the quote is not "Consistency is the + hobgoblin of little minds", but "A *foolish* consistency is the + hobgoblin of little minds". Consistency rocks! + +Use containment as scoping + In the previous example, all the names are prefixed with "proc-", + which is redundant given that they are nested under the process table. + +Think about your users + Have empathy for your users, choosing clear and useful fields that + contain clear and useful data. You may need to augment the display + content with xo_attr() calls (:ref:`xo_attr`) or "{e:}" + fields (:ref:`encoding-modifier`) to make the data useful. + +Don't use an arbitrary number postfix + What does "errors2" mean? No one will know. "errors-after-restart" + would be a better choice. Think of your users, and think of the + future. If you make "errors2", the next guy will happily make + "errors3" and before you know it, someone will be asking what's the + difference between errors37 and errors63. + +Be consistent, uniform, unsurprising, and predictable + Think of your field vocabulary as an API. You want it useful, + expressive, meaningful, direct, and obvious. You want the client + application's programmer to move between without the need to + understand a variety of opinions on how fields are named. They + should see the system as a single cohesive whole, not a sack of + cats. + +Field names constitute the means by which client programmers interact +with our system. By choosing wise names now, you are making their +lives better. + +After using `xolint` to find errors in your field descriptors, use +"`xolint -V`" to spell check your field names and to help you detect +different names for the same data. "dropped-short" and +"dropped-too-short" are both reasonable names, but using them both +will lead users to ask the difference between the two fields. If +there is no difference, use only one of the field names. If there is +a difference, change the names to make that difference more obvious. + +What does this message mean? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + xolint-errors.rst diff --git a/contrib/libxo/doc/field-formatting.rst b/contrib/libxo/doc/field-formatting.rst new file mode 100644 index 000000000000..1a4a29af6e64 --- /dev/null +++ b/contrib/libxo/doc/field-formatting.rst @@ -0,0 +1,371 @@ + +.. index:: Field Formatting +.. _field-formatting: + +Field Formatting +---------------- + +The field format is similar to the format string for printf(3). Its +use varies based on the role of the field, but generally is used to +format the field's contents. + +If the format string is not provided for a value field, it defaults to +"%s". + +Note a field definition can contain zero or more printf-style +'directives', which are sequences that start with a '%' and end with +one of following characters: "diouxXDOUeEfFgGaAcCsSp". Each directive +is matched by one of more arguments to the xo_emit function. + +The format string has the form:: + + '%' format-modifier * format-character + +The format-modifier can be: + +- a '#' character, indicating the output value should be prefixed + with '0x', typically to indicate a base 16 (hex) value. +- a minus sign ('-'), indicating the output value should be padded on + the right instead of the left. +- a leading zero ('0') indicating the output value should be padded on the + left with zeroes instead of spaces (' '). +- one or more digits ('0' - '9') indicating the minimum width of the + argument. If the width in columns of the output value is less than + the minimum width, the value will be padded to reach the minimum. +- a period followed by one or more digits indicating the maximum + number of bytes which will be examined for a string argument, or the maximum + width for a non-string argument. When handling ASCII strings this + functions as the field width but for multi-byte characters, a single + character may be composed of multiple bytes. + xo_emit will never dereference memory beyond the given number of bytes. +- a second period followed by one or more digits indicating the maximum + width for a string argument. This modifier cannot be given for non-string + arguments. +- one or more 'h' characters, indicating shorter input data. +- one or more 'l' characters, indicating longer input data. +- a 'z' character, indicating a 'size_t' argument. +- a 't' character, indicating a 'ptrdiff_t' argument. +- a ' ' character, indicating a space should be emitted before + positive numbers. +- a '+' character, indicating sign should emitted before any number. + +Note that 'q', 'D', 'O', and 'U' are considered deprecated and will be +removed eventually. + +The format character is described in the following table: + + ===== ================= ====================== + Ltr Argument Type Format + ===== ================= ====================== + d int base 10 (decimal) + i int base 10 (decimal) + o int base 8 (octal) + u unsigned base 10 (decimal) + x unsigned base 16 (hex) + X unsigned long base 16 (hex) + D long base 10 (decimal) + O unsigned long base 8 (octal) + U unsigned long base 10 (decimal) + e double [-]d.ddde+-dd + E double [-]d.dddE+-dd + f double [-]ddd.ddd + F double [-]ddd.ddd + g double as 'e' or 'f' + G double as 'E' or 'F' + a double [-]0xh.hhhp[+-]d + A double [-]0Xh.hhhp[+-]d + c unsigned char a character + C wint_t a character + s char \* a UTF-8 string + S wchar_t \* a unicode/WCS string + p void \* '%#lx' + ===== ================= ====================== + +The 'h' and 'l' modifiers affect the size and treatment of the +argument: + + ===== ============= ==================== + Mod d, i o, u, x, X + ===== ============= ==================== + hh signed char unsigned char + h short unsigned short + l long unsigned long + ll long long unsigned long long + j intmax_t uintmax_t + t ptrdiff_t ptrdiff_t + z size_t size_t + q quad_t u_quad_t + ===== ============= ==================== + +.. index:: UTF-8 +.. index:: Locale + +.. _utf-8: + +UTF-8 and Locale Strings +~~~~~~~~~~~~~~~~~~~~~~~~ + +For strings, the 'h' and 'l' modifiers affect the interpretation of +the bytes pointed to argument. The default '%s' string is a 'char \*' +pointer to a string encoded as UTF-8. Since UTF-8 is compatible with +ASCII data, a normal 7-bit ASCII string can be used. '%ls' expects a +'wchar_t \*' pointer to a wide-character string, encoded as a 32-bit +Unicode values. '%hs' expects a 'char \*' pointer to a multi-byte +string encoded with the current locale, as given by the LC_CTYPE, +LANG, or LC_ALL environment varibles. The first of this list of +variables is used and if none of the variables are set, the locale +defaults to "UTF-8". + +libxo will convert these arguments as needed to either UTF-8 (for XML, +JSON, and HTML styles) or locale-based strings for display in text +style:: + + xo_emit("All strings are utf-8 content {:tag/%ls}", + L"except for wide strings"); + + ======== ================== =============================== + Format Argument Type Argument Contents + ======== ================== =============================== + %s const char \* UTF-8 string + %S const char \* UTF-8 string (alias for '%ls') + %ls const wchar_t \* Wide character UNICODE string + %hs const char * locale-based string + ======== ================== =============================== + +.. admonition:: "Long", not "locale" + + The "*l*" in "%ls" is for "*long*", following the convention of "%ld". + It is not "*locale*", a common mis-mnemonic. "%S" is equivalent to + "%ls". + +For example, the following function is passed a locale-base name, a +hat size, and a time value. The hat size is formatted in a UTF-8 +(ASCII) string, and the time value is formatted into a wchar_t +string:: + + void print_order (const char *name, int size, + struct tm *timep) { + char buf[32]; + const char *size_val = "unknown"; + + if (size > 0) + snprintf(buf, sizeof(buf), "%d", size); + size_val = buf; + } + + wchar_t when[32]; + wcsftime(when, sizeof(when), L"%d%b%y", timep); + + xo_emit("The hat for {:name/%hs} is {:size/%s}.\n", + name, size_val); + xo_emit("It was ordered on {:order-time/%ls}.\n", + when); + } + +It is important to note that xo_emit will perform the conversion +required to make appropriate output. Text style output uses the +current locale (as described above), while XML, JSON, and HTML use +UTF-8. + +UTF-8 and locale-encoded strings can use multiple bytes to encode one +column of data. The traditional "precision'" (aka "max-width") value +for "%s" printf formatting becomes overloaded since it specifies both +the number of bytes that can be safely referenced and the maximum +number of columns to emit. xo_emit uses the precision as the former, +and adds a third value for specifying the maximum number of columns. + +In this example, the name field is printed with a minimum of 3 columns +and a maximum of 6. Up to ten bytes of data at the location given by +'name' are in used in filling those columns:: + + xo_emit("{:name/%3.10.6s}", name); + +Characters Outside of Field Definitions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Characters in the format string that are not part of a field +definition are copied to the output for the TEXT style, and are +ignored for the JSON and XML styles. For HTML, these characters are +placed in a <div> with class "text":: + + EXAMPLE: + xo_emit("The hat is {:size/%s}.\n", size_val); + TEXT: + The hat is extra small. + XML: + <size>extra small</size> + JSON: + "size": "extra small" + HTML: + <div class="text">The hat is </div> + <div class="data" data-tag="size">extra small</div> + <div class="text">.</div> + +.. index:: errno + +"%m" Is Supported +~~~~~~~~~~~~~~~~~ + +libxo supports the '%m' directive, which formats the error message +associated with the current value of "errno". It is the equivalent +of "%s" with the argument strerror(errno):: + + xo_emit("{:filename} cannot be opened: {:error/%m}", filename); + xo_emit("{:filename} cannot be opened: {:error/%s}", + filename, strerror(errno)); + +"%n" Is Not Supported +~~~~~~~~~~~~~~~~~~~~~ + +libxo does not support the '%n' directive. It's a bad idea and we +just don't do it. + +The Encoding Format (eformat) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The "eformat" string is the format string used when encoding the field +for JSON and XML. If not provided, it defaults to the primary format +with any minimum width removed. If the primary is not given, both +default to "%s". + +Content Strings +~~~~~~~~~~~~~~~ + +For padding and labels, the content string is considered the content, +unless a format is given. + +.. index:: printf-like + +Argument Validation +~~~~~~~~~~~~~~~~~~~ + +Many compilers and tool chains support validation of printf-like +arguments. When the format string fails to match the argument list, +a warning is generated. This is a valuable feature and while the +formatting strings for libxo differ considerably from printf, many of +these checks can still provide build-time protection against bugs. + +libxo provide variants of functions that provide this ability, if the +"--enable-printflike" option is passed to the "configure" script. +These functions use the "_p" suffix, like "xo_emit_p()", +xo_emit_hp()", etc. + +The following are features of libxo formatting strings that are +incompatible with printf-like testing: + +- implicit formats, where "{:tag}" has an implicit "%s"; +- the "max" parameter for strings, where "{:tag/%4.10.6s}" means up to + ten bytes of data can be inspected to fill a minimum of 4 columns and + a maximum of 6; +- percent signs in strings, where "{:filled}%" makes a single, + trailing percent sign; +- the "l" and "h" modifiers for strings, where "{:tag/%hs}" means + locale-based string and "{:tag/%ls}" means a wide character string; +- distinct encoding formats, where "{:tag/#%s/%s}" means the display + styles (text and HTML) will use "#%s" where other styles use "%s"; + +If none of these features are in use by your code, then using the "_p" +variants might be wise: + + ================== ======================== + Function printf-like Equivalent + ================== ======================== + xo_emit_hv xo_emit_hvp + xo_emit_h xo_emit_hp + xo_emit xo_emit_p + xo_emit_warn_hcv xo_emit_warn_hcvp + xo_emit_warn_hc xo_emit_warn_hcp + xo_emit_warn_c xo_emit_warn_cp + xo_emit_warn xo_emit_warn_p + xo_emit_warnx xo_emit_warnx_p + xo_emit_err xo_emit_err_p + xo_emit_errx xo_emit_errx_p + xo_emit_errc xo_emit_errc_p + ================== ======================== + +.. index:: performance +.. index:: XOEF_RETAIN + +.. _retain: + +Retaining Parsed Format Information +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +libxo can retain the parsed internal information related to the given +format string, allowing subsequent xo_emit calls, the retained +information is used, avoiding repetitive parsing of the format string:: + + SYNTAX: + int xo_emit_f(xo_emit_flags_t flags, const char fmt, ...); + EXAMPLE: + xo_emit_f(XOEF_RETAIN, "{:some/%02d}{:thing/%-6s}{:fancy}\n", + some, thing, fancy); + +To retain parsed format information, use the XOEF_RETAIN flag to the +xo_emit_f() function. A complete set of xo_emit_f functions exist to +match all the xo_emit function signatures (with handles, varadic +argument, and printf-like flags): + + ================== ======================== + Function Flags Equivalent + ================== ======================== + xo_emit_hv xo_emit_hvf + xo_emit_h xo_emit_hf + xo_emit xo_emit_f + xo_emit_hvp xo_emit_hvfp + xo_emit_hp xo_emit_hfp + xo_emit_p xo_emit_fp + ================== ======================== + +The format string must be immutable across multiple calls to xo_emit_f(), +since the library retains the string. Typically this is done by using +static constant strings, such as string literals. If the string is not +immutable, the XOEF_RETAIN flag must not be used. + +The functions xo_retain_clear() and xo_retain_clear_all() release +internal information on either a single format string or all format +strings, respectively. Neither is required, but the library will +retain this information until it is cleared or the process exits:: + + const char *fmt = "{:name} {:count/%d}\n"; + for (i = 0; i < 1000; i++) { + xo_open_instance("item"); + xo_emit_f(XOEF_RETAIN, fmt, name[i], count[i]); + } + xo_retain_clear(fmt); + +The retained information is kept as thread-specific data. + +Example +~~~~~~~ + +In this example, the value for the number of items in stock is emitted:: + + xo_emit("{P: }{Lwc:In stock}{:in-stock/%u}\n", + instock); + +This call will generate the following output:: + + TEXT: + In stock: 144 + XML: + <in-stock>144</in-stock> + JSON: + "in-stock": 144, + HTML: + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">144</div> + </div> + +Clearly HTML wins the verbosity award, and this output does +not include XOF_XPATH or XOF_INFO data, which would expand the +penultimate line to:: + + <div class="data" data-tag="in-stock" + data-xpath="/top/data/item/in-stock" + data-type="number" + data-help="Number of items in stock">144</div> diff --git a/contrib/libxo/doc/field-modifiers.rst b/contrib/libxo/doc/field-modifiers.rst new file mode 100644 index 000000000000..ba2073bbdb68 --- /dev/null +++ b/contrib/libxo/doc/field-modifiers.rst @@ -0,0 +1,353 @@ + +.. index:: Field Modifiers +.. _field-modifiers: + +Field Modifiers +~~~~~~~~~~~~~~~ + +Field modifiers are flags which modify the way content emitted for +particular output styles: + + === =============== =================================================== + M Name Description + === =============== =================================================== + a argument The content appears as a 'const char \*' argument + c colon A colon (":") is appended after the label + d display Only emit field for display styles (text/HTML) + e encoding Only emit for encoding styles (XML/JSON) + g gettext Call gettext on field's render content + h humanize (hn) Format large numbers in human-readable style + \ hn-space Humanize: Place space between numeric and unit + \ hn-decimal Humanize: Add a decimal digit, if number < 10 + \ hn-1000 Humanize: Use 1000 as divisor instead of 1024 + k key Field is a key, suitable for XPath predicates + l leaf-list Field is a leaf-list + n no-quotes Do not quote the field when using JSON style + p plural Gettext: Use comma-separated plural form + q quotes Quote the field when using JSON style + t trim Trim leading and trailing whitespace + w white A blank (" ") is appended after the label + === =============== =================================================== + +Roles and modifiers can also use more verbose names, when preceded by +a comma. For example, the modifier string "Lwc" (or "L,white,colon") +means the field has a label role (text that describes the next field) +and should be followed by a colon ('c') and a space ('w'). The +modifier string "Vkq" (or ":key,quote") means the field has a value +role (the default role), that it is a key for the current instance, +and that the value should be quoted when encoded for JSON. + +.. index:: Field Modifiers; Argument +.. _argument-modifier: + +The Argument Modifier ({a:}) +++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Argument + +The argument modifier indicates that the content of the field +descriptor will be placed as a UTF-8 string (const char \*) argument +within the xo_emit parameters:: + + EXAMPLE: + xo_emit("{La:} {a:}\n", "Label text", "label", "value"); + TEXT: + Label text value + JSON: + "label": "value" + XML: + <label>value</label> + +The argument modifier allows field names for value fields to be passed +on the stack, avoiding the need to build a field descriptor using +snprintf. For many field roles, the argument modifier is not needed, +since those roles have specific mechanisms for arguments, such as +"{C:fg-%s}". + +.. index:: Field Modifiers; Colon +.. _colon-modifier: + +The Colon Modifier ({c:}) ++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Colon + +The colon modifier appends a single colon to the data value:: + + EXAMPLE: + xo_emit("{Lc:Name}{:name}\n", "phil"); + TEXT: + Name:phil + +The colon modifier is only used for the TEXT and HTML output +styles. It is commonly combined with the space modifier ('{w:}'). +It is purely a convenience feature. + +.. index:: Field Modifiers; Display +.. _display-modifier: + +The Display Modifier ({d:}) ++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Display + +The display modifier indicated the field should only be generated for +the display output styles, TEXT and HTML:: + + EXAMPLE: + xo_emit("{Lcw:Name}{d:name} {:id/%d}\n", "phil", 1); + TEXT: + Name: phil 1 + XML: + <id>1</id> + +The display modifier is the opposite of the encoding modifier, and +they are often used to give to distinct views of the underlying data. + +.. index:: Field Modifiers; Encoding +.. _encoding-modifier: + +The Encoding Modifier ({e:}) +++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Encoding + +The display modifier indicated the field should only be generated for +the display output styles, TEXT and HTML:: + + EXAMPLE: + xo_emit("{Lcw:Name}{:name} {e:id/%d}\n", "phil", 1); + TEXT: + Name: phil + XML: + <name>phil</name><id>1</id> + +The encoding modifier is the opposite of the display modifier, and +they are often used to give to distinct views of the underlying data. + +.. index:: Field Modifiers; Gettext +.. _gettext-modifier: + +The Gettext Modifier ({g:}) ++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Gettext +.. index:: gettext + +The gettext modifier is used to translate individual fields using the +gettext domain (typically set using the "`{G:}`" role) and current +language settings. Once libxo renders the field value, it is passed +to gettext(3), where it is used as a key to find the native language +translation. + +In the following example, the strings "State" and "full" are passed +to gettext() to find locale-based translated strings:: + + xo_emit("{Lgwc:State}{g:state}\n", "full"); + +See :ref:`gettext-role`, :ref:`plural-modifier`, and +:ref:`i18n` for additional details. + +.. index:: Field Modifiers; Humanize +.. _humanize-modifier: + +The Humanize Modifier ({h:}) +++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Humanize + +The humanize modifier is used to render large numbers as in a +human-readable format. While numbers like "44470272" are completely +readable to computers and savants, humans will generally find "44M" +more meaningful. + +"hn" can be used as an alias for "humanize". + +The humanize modifier only affects display styles (TEXT and HMTL). +The "`no-humanize`" option (See :ref:`options`) will block +the function of the humanize modifier. + +There are a number of modifiers that affect details of humanization. +These are only available in as full names, not single characters. The +"`hn-space`" modifier places a space between the number and any +multiplier symbol, such as "M" or "K" (ex: "44 K"). The +"`hn-decimal`" modifier will add a decimal point and a single tenths +digit when the number is less than 10 (ex: "4.4K"). The "`hn-1000`" +modifier will use 1000 as divisor instead of 1024, following the +JEDEC-standard instead of the more natural binary powers-of-two +tradition:: + + EXAMPLE: + xo_emit("{h:input/%u}, {h,hn-space:output/%u}, " + "{h,hn-decimal:errors/%u}, {h,hn-1000:capacity/%u}, " + "{h,hn-decimal:remaining/%u}\n", + input, output, errors, capacity, remaining); + TEXT: + 21, 57 K, 96M, 44M, 1.2G + +In the HTML style, the original numeric value is rendered in the +"data-number" attribute on the <div> element:: + + <div class="data" data-tag="errors" + data-number="100663296">96M</div> + +.. index:: Field Modifiers; Key +.. _key-modifier: + +The Key Modifier ({k:}) ++++++++++++++++++++++++ + +.. index:: Field Modifiers; Key + +The key modifier is used to indicate that a particular field helps +uniquely identify an instance of list data:: + + EXAMPLE: + xo_open_list("user"); + for (i = 0; i < num_users; i++) { + xo_open_instance("user"); + xo_emit("User {k:name} has {:count} tickets\n", + user[i].u_name, user[i].u_tickets); + xo_close_instance("user"); + } + xo_close_list("user"); + +.. index:: XOF_XPATH + +Currently the key modifier is only used when generating XPath value +for the HTML output style when XOF_XPATH is set, but other uses are +likely in the near future. + +.. index:: Field Modifiers; Leaf-List +.. _leaf-list: + +The Leaf-List Modifier ({l:}) ++++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Leaf-List + +The leaf-list modifier is used to distinguish lists where each +instance consists of only a single value. In XML, these are +rendered as single elements, where JSON renders them as arrays:: + + EXAMPLE: + for (i = 0; i < num_users; i++) { + xo_emit("Member {l:user}\n", user[i].u_name); + } + XML: + <user>phil</user> + <user>pallavi</user> + JSON: + "user": [ "phil", "pallavi" ] + +The name of the field must match the name of the leaf list. + +.. index:: Field Modifiers; No-Quotes +.. _no-quotes-modifier: + +The No-Quotes Modifier ({n:}) ++++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; No-Quotes + +The no-quotes modifier (and its twin, the 'quotes' modifier) affect +the quoting of values in the JSON output style. JSON uses quotes for +string value, but no quotes for numeric, boolean, and null data. +xo_emit applies a simple heuristic to determine whether quotes are +needed, but often this needs to be controlled by the caller:: + + EXAMPLE: + const char *bool = is_true ? "true" : "false"; + xo_emit("{n:fancy/%s}", bool); + JSON: + "fancy": true + +.. index:: Field Modifiers; Plural +.. _plural-modifier: + +The Plural Modifier ({p:}) +++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Plural +.. index:: gettext + +The plural modifier selects the appropriate plural form of an +expression based on the most recent number emitted and the current +language settings. The contents of the field should be the singular +and plural English values, separated by a comma:: + + xo_emit("{:bytes} {Ngp:byte,bytes}\n", bytes); + +The plural modifier is meant to work with the gettext modifier ({g:}) +but can work independently. See :ref:`gettext-modifier`. + +When used without the gettext modifier or when the message does not +appear in the message catalog, the first token is chosen when the last +numeric value is equal to 1; otherwise the second value is used, +mimicking the simple pluralization rules of English. + +When used with the gettext modifier, the ngettext(3) function is +called to handle the heavy lifting, using the message catalog to +convert the singular and plural forms into the native language. + +.. index:: Field Modifiers; Quotes +.. _quotes-modifier: + +The Quotes Modifier ({q:}) +++++++++++++++++++++++++++ + +.. index:: Field Modifiers; Quotes + +The quotes modifier (and its twin, the 'no-quotes' modifier) affect +the quoting of values in the JSON output style. JSON uses quotes for +string value, but no quotes for numeric, boolean, and null data. +xo_emit applies a simple heuristic to determine whether quotes are +needed, but often this needs to be controlled by the caller:: + + EXAMPLE: + xo_emit("{q:time/%d}", 2014); + JSON: + "year": "2014" + +The heuristic is based on the format; if the format uses any of the +following conversion specifiers, then no quotes are used:: + + d i o u x X D O U e E f F g G a A c C p + +.. index:: Field Modifiers; Trim +.. _trim-modifier: + +The Trim Modifier ({t:}) +++++++++++++++++++++++++ + +.. index:: Field Modifiers; Trim + +The trim modifier removes any leading or trailing whitespace from +the value:: + + EXAMPLE: + xo_emit("{t:description}", " some input "); + JSON: + "description": "some input" + +.. index:: Field Modifiers; White Space +.. _white-space-modifier: + +The White Space Modifier ({w:}) ++++++++++++++++++++++++++++++++ + +.. index:: Field Modifiers; White Space + +The white space modifier appends a single space to the data value:: + + EXAMPLE: + xo_emit("{Lw:Name}{:name}\n", "phil"); + TEXT: + Name phil + +The white space modifier is only used for the TEXT and HTML output +styles. It is commonly combined with the colon modifier ('{c:}'). +It is purely a convenience feature. + +Note that the sense of the 'w' modifier is reversed for the units role +({Uw:}); a blank is added before the contents, rather than after it. diff --git a/contrib/libxo/doc/field-roles.rst b/contrib/libxo/doc/field-roles.rst new file mode 100644 index 000000000000..3499aea81aba --- /dev/null +++ b/contrib/libxo/doc/field-roles.rst @@ -0,0 +1,317 @@ + +.. index:: Field Roles +.. _field-roles: + +Field Roles +~~~~~~~~~~~ + +Field roles are optional, and indicate the role and formatting of the +content. The roles are listed below; only one role is permitted: + + === ============== ================================================= + R Name Description + === ============== ================================================= + C color Field has color and effect controls + D decoration Field is non-text (e.g., colon, comma) + E error Field is an error message + G gettext Call gettext(3) on the format string + L label Field is text that prefixes a value + N note Field is text that follows a value + P padding Field is spaces needed for vertical alignment + T title Field is a title value for headings + U units Field is the units for the previous value field + V value Field is the name of field (the default) + W warning Field is a warning message + [ start-anchor Begin a section of anchored variable-width text + ] stop-anchor End a section of anchored variable-width text + === ============== ================================================= + +:: + + EXAMPLE: + xo_emit("{L:Free}{D::}{P: }{:free/%u} {U:Blocks}\n", + free_blocks); + +When a role is not provided, the "*value*" role is used as the default. + +Roles and modifiers can also use more verbose names, when preceded by +a comma:: + + EXAMPLE: + xo_emit("{,label:Free}{,decoration::}{,padding: }" + "{,value:free/%u} {,units:Blocks}\n", + free_blocks); + +.. index:: Field Roles; Color +.. _color-role: + +The Color Role ({C:}) ++++++++++++++++++++++ + +Colors and effects control how text values are displayed; they are +used for display styles (TEXT and HTML):: + + xo_emit("{C:bold}{:value}{C:no-bold}\n", value); + +Colors and effects remain in effect until modified by other "C"-role +fields:: + + xo_emit("{C:bold}{C:inverse}both{C:no-bold}only inverse\n"); + +If the content is empty, the "*reset*" action is performed:: + + xo_emit("{C:both,underline}{:value}{C:}\n", value); + +The content should be a comma-separated list of zero or more colors or +display effects:: + + xo_emit("{C:bold,inverse}Ugly{C:no-bold,no-inverse}\n"); + +The color content can be either static, when placed directly within +the field descriptor, or a printf-style format descriptor can be used, +if preceded by a slash ("/"): + + xo_emit("{C:/%s%s}{:value}{C:}", need_bold ? "bold" : "", + need_underline ? "underline" : "", value); + +Color names are prefixed with either "fg-" or "bg-" to change the +foreground and background colors, respectively:: + + xo_emit("{C:/fg-%s,bg-%s}{Lwc:Cost}{:cost/%u}{C:reset}\n", + fg_color, bg_color, cost); + +The following table lists the supported effects: + + =============== ================================================= + Name Description + =============== ================================================= + bg-XXXXX Change background color + bold Start bold text effect + fg-XXXXX Change foreground color + inverse Start inverse (aka reverse) text effect + no-bold Stop bold text effect + no-inverse Stop inverse (aka reverse) text effect + no-underline Stop underline text effect + normal Reset effects (only) + reset Reset colors and effects (restore defaults) + underline Start underline text effect + =============== ================================================= + +The following color names are supported: + + ========= ============================================ + Name Description + ========= ============================================ + black + blue + cyan + default Default color for foreground or background + green + magenta + red + white + yellow + ========= ============================================ + +When using colors, the developer should remember that users will +change the foreground and background colors of terminal session +according to their own tastes, so assuming that "blue" looks nice is +never safe, and is a constant annoyance to your dear author. In +addition, a significant percentage of users (1 in 12) will be color +blind. Depending on color to convey critical information is not a +good idea. Color should enhance output, but should not be used as the +sole means of encoding information. + +.. index:: Field Roles; Decoration +.. _decoration-role: + +The Decoration Role ({D:}) +++++++++++++++++++++++++++ + +Decorations are typically punctuation marks such as colons, +semi-colons, and commas used to decorate the text and make it simpler +for human readers. By marking these distinctly, HTML usage scenarios +can use CSS to direct their display parameters:: + + xo_emit("{D:((}{:name}{D:))}\n", name); + +.. index:: Field Roles; Gettext +.. _gettext-role: + +The Gettext Role ({G:}) ++++++++++++++++++++++++ + +libxo supports internationalization (i18n) through its use of +gettext(3). Use the "{G:}" role to request that the remaining part of +the format string, following the "{G:}" field, be handled using +gettext(). + +Since gettext() uses the string as the key into the message catalog, +libxo uses a simplified version of the format string that removes +unimportant field formatting and modifiers, stopping minor formatting +changes from impacting the expensive translation process. A developer +change such as changing "/%06d" to "/%08d" should not force hand +inspection of all .po files. + +The simplified version can be generated for a single message using the +"`xopo -s $text`" command, or an entire .pot can be translated using +the "`xopo -f $input -o $output`" command. + + xo_emit("{G:}Invalid token\n"); + +The {G:} role allows a domain name to be set. gettext calls will +continue to use that domain name until the current format string +processing is complete, enabling a library function to emit strings +using it's own catalog. The domain name can be either static as the +content of the field, or a format can be used to get the domain name +from the arguments. + + xo_emit("{G:libc}Service unavailable in restricted mode\n"); + +See :ref:`i18n` for additional details. + +.. index:: Field Roles; Label +.. _label-role: + +The Label Role ({L:}) ++++++++++++++++++++++ + +Labels are text that appears before a value:: + + xo_emit("{Lwc:Cost}{:cost/%u}\n", cost); + +If a label needs to include a slash, it must be escaped using two +backslashes, one for the C compiler and one for libxo:: + + xo_emit("{Lc:Low\\/warn level}{:level/%s}\n", level); + +.. index:: Field Roles; Note +.. _note-role: + +The Note Role ({N:}) +++++++++++++++++++++ + +Notes are text that appears after a value:: + + xo_emit("{:cost/%u} {N:per year}\n", cost); + +.. index:: Field Roles; Padding +.. _padding-role: + +The Padding Role ({P:}) ++++++++++++++++++++++++ + +Padding represents whitespace used before and between fields. + +The padding content can be either static, when placed directly within +the field descriptor, or a printf-style format descriptor can be used, +if preceded by a slash ("/"):: + + xo_emit("{P: }{Lwc:Cost}{:cost/%u}\n", cost); + xo_emit("{P:/%30s}{Lwc:Cost}{:cost/%u}\n", "", cost); + +.. index:: Field Roles; Title +.. _title-role: + +The Title Role ({T:}) ++++++++++++++++++++++ + +Title are heading or column headers that are meant to be displayed to +the user. The title can be either static, when placed directly within +the field descriptor, or a printf-style format descriptor can be used, +if preceded by a slash ("/"):: + + xo_emit("{T:Interface Statistics}\n"); + xo_emit("{T:/%20.20s}{T:/%6.6s}\n", "Item Name", "Cost"); + +Title fields have an extra convenience feature; if both content and +format are specified, instead of looking to the argument list for a +value, the content is used, allowing a mixture of format and content +within the field descriptor:: + + xo_emit("{T:Name/%20s}{T:Count/%6s}\n"); + +Since the incoming argument is a string, the format must be "%s" or +something suitable. + +.. index:: Field Roles; Units +.. index:: XOF_UNITS +.. _units-role: + +The Units Role ({U:}) ++++++++++++++++++++++ + +Units are the dimension by which values are measured, such as degrees, +miles, bytes, and decibels. The units field carries this information +for the previous value field:: + + xo_emit("{Lwc:Distance}{:distance/%u}{Uw:miles}\n", miles); + +Note that the sense of the 'w' modifier is reversed for units; +a blank is added before the contents, rather than after it. + +When the XOF_UNITS flag is set, units are rendered in XML as the +"units" attribute:: + + <distance units="miles">50</distance> + +Units can also be rendered in HTML as the "data-units" attribute:: + + <div class="data" data-tag="distance" data-units="miles" + data-xpath="/top/data/distance">50</div> + +.. index:: Field Roles; Value +.. _value-role: + +The Value Role ({V:} and {:}) ++++++++++++++++++++++++++++++ + +The value role is used to represent the a data value that is +interesting for the non-display output styles (XML and JSON). Value +is the default role; if no other role designation is given, the field +is a value. The field name must appear within the field descriptor, +followed by one or two format descriptors. The first format +descriptor is used for display styles (TEXT and HTML), while the +second one is used for encoding styles (XML and JSON). If no second +format is given, the encoding format defaults to the first format, +with any minimum width removed. If no first format is given, both +format descriptors default to "%s":: + + xo_emit("{:length/%02u}x{:width/%02u}x{:height/%02u}\n", + length, width, height); + xo_emit("{:author} wrote \"{:poem}\" in {:year/%4d}\n, + author, poem, year); + +.. index:: Field Roles; Anchor +.. _anchor-role: + +The Anchor Roles ({[:} and {]:}) +++++++++++++++++++++++++++++++++ + +The anchor roles allow a set of strings by be padded as a group, +but still be visible to xo_emit as distinct fields. Either the start +or stop anchor can give a field width and it can be either directly in +the descriptor or passed as an argument. Any fields between the start +and stop anchor are padded to meet the minimum width given. + +To give a width directly, encode it as the content of the anchor tag:: + + xo_emit("({[:10}{:min/%d}/{:max/%d}{]:})\n", min, max); + +To pass a width as an argument, use "%d" as the format, which must +appear after the "/". Note that only "%d" is supported for widths. +Using any other value could ruin your day:: + + xo_emit("({[:/%d}{:min/%d}/{:max/%d}{]:})\n", width, min, max); + +If the width is negative, padding will be added on the right, suitable +for left justification. Otherwise the padding will be added to the +left of the fields between the start and stop anchors, suitable for +right justification. If the width is zero, nothing happens. If the +number of columns of output between the start and stop anchors is less +than the absolute value of the given width, nothing happens. + +.. index:: XOF_WARN + +Widths over 8k are considered probable errors and not supported. If +XOF_WARN is set, a warning will be generated. diff --git a/contrib/libxo/doc/format-strings.rst b/contrib/libxo/doc/format-strings.rst new file mode 100644 index 000000000000..44e02abd41e7 --- /dev/null +++ b/contrib/libxo/doc/format-strings.rst @@ -0,0 +1,47 @@ + +.. index:: Format Strings +.. _format-strings: + +Format Strings +-------------- + +libxo uses format strings to control the rendering of data into the +various output styles. Each format string contains a set of zero or +more field descriptions, which describe independent data fields. Each +field description contains a set of modifiers, a content string, and +zero, one, or two format descriptors. The modifiers tell libxo what +the field is and how to treat it, while the format descriptors are +formatting instructions using printf-style format strings, telling +libxo how to format the field. The field description is placed inside +a set of braces, with a colon (":") after the modifiers and a slash +("/") before each format descriptors. Text may be intermixed with +field descriptions within the format string. + +The field description is given as follows:: + + '{' [ role | modifier ]* [',' long-names ]* ':' [ content ] + [ '/' field-format [ '/' encoding-format ]] '}' + +The role describes the function of the field, while the modifiers +enable optional behaviors. The contents, field-format, and +encoding-format are used in varying ways, based on the role. These +are described in the following sections. + +In the following example, three field descriptors appear. The first +is a padding field containing three spaces of padding, the second is a +label ("In stock"), and the third is a value field ("in-stock"). The +in-stock field has a "%u" format that will parse the next argument +passed to the xo_emit function as an unsigned integer:: + + xo_emit("{P: }{Lwc:In stock}{:in-stock/%u}\n", 65); + +This single line of code can generate text (" In stock: 65\n"), XML +("<in-stock>65</in-stock>"), JSON ('"in-stock": 6'), or HTML (too +lengthy to be listed here). + +While roles and modifiers typically use single character for brevity, +there are alternative names for each which allow more verbose +formatting strings. These names must be preceded by a comma, and may +follow any single-character values:: + + xo_emit("{L,white,colon:In stock}{,key:in-stock/%u}\n", 65); diff --git a/contrib/libxo/doc/formatting.rst b/contrib/libxo/doc/formatting.rst new file mode 100644 index 000000000000..dbbdd24dfcc8 --- /dev/null +++ b/contrib/libxo/doc/formatting.rst @@ -0,0 +1,165 @@ + +Formatting with libxo +===================== + +Most unix commands emit text output aimed at humans. It is designed +to be parsed and understood by a user. Humans are gifted at +extracting details and pattern matching in such output. Often +programmers need to extract information from this human-oriented +output. Programmers use tools like grep, awk, and regular expressions +to ferret out the pieces of information they need. Such solutions are +fragile and require maintenance when output contents change or evolve, +along with testing and validation. + +Modern tool developers favor encoding schemes like XML and JSON, +which allow trivial parsing and extraction of data. Such formats are +simple, well understood, hierarchical, easily parsed, and often +integrate easier with common tools and environments. Changes to +content can be done in ways that do not break existing users of the +data, which can reduce maintenance costs and increase feature velocity. + +In addition, modern reality means that more output ends up in web +browsers than in terminals, making HTML output valuable. + +libxo allows a single set of function calls in source code to generate +traditional text output, as well as XML and JSON formatted data. HTML +can also be generated; "<div>" elements surround the traditional text +output, with attributes that detail how to render the data. + +A single libxo function call in source code is all that's required:: + + xo_emit("Connecting to {:host}.{:domain}...\n", host, domain); + + TEXT: + Connecting to my-box.example.com... + XML: + <host>my-box</host> + <domain>example.com</domain> + JSON: + "host": "my-box", + "domain": "example.com" + HTML: + <div class="line"> + <div class="text">Connecting to </div> + <div class="data" data-tag="host" + data-xpath="/top/host">my-box</div> + <div class="text">.</div> + <div class="data" data-tag="domain" + data-xpath="/top/domain">example.com</div> + <div class="text">...</div> + </div> + +Encoding Styles +--------------- + +There are four encoding styles supported by libxo: + +- TEXT output can be display on a terminal session, allowing + compatibility with traditional command line usage. +- XML output is suitable for tools like XPath and protocols like + NETCONF. +- JSON output can be used for RESTful APIs and integration with + languages like Javascript and Python. +- HTML can be matched with a small CSS file to permit rendering in any + HTML5 browser. + +In general, XML and JSON are suitable for encoding data, while TEXT is +suited for terminal output and HTML is suited for display in a web +browser (see :ref:`xohtml`). + +Text Output +~~~~~~~~~~~ + +Most traditional programs generate text output on standard output, +with contents like:: + + 36 ./src + 40 ./bin + 90 . + +In this example (taken from *du* source code), the code to generate this +data might look like:: + + printf("%d\t%s\n", num_blocks, path); + +Simple, direct, obvious. But it's only making text output. Imagine +using a single code path to make TEXT, XML, JSON or HTML, deciding at +run time which to generate. + +libxo expands on the idea of printf format strings to make a single +format containing instructions for creating multiple output styles:: + + xo_emit("{:blocks/%d}\t{:path/%s}\n", num_blocks, path); + +This line will generate the same text output as the earlier printf +call, but also has enough information to generate XML, JSON, and HTML. + +The following sections introduce the other formats. + +XML Output +~~~~~~~~~~ + +XML output consists of a hierarchical set of elements, each encoded +with a start tag and an end tag. The element should be named for data +value that it is encoding:: + + <item> + <blocks>36</blocks> + <path>./src</path> + </item> + <item> + <blocks>40</blocks> + <path>./bin</path> + </item> + <item> + <blocks>90</blocks> + <path>.</path> + </item> + +`XML`_ is the W3C standard for encoding data. + +.. _XML: https://w3c.org/TR/xml + +JSON Output +~~~~~~~~~~~ + +JSON output consists of a hierarchical set of objects and lists, each +encoded with a quoted name, a colon, and a value. If the value is a +string, it must be quoted, but numbers are not quoted. Objects are +encoded using braces; lists are encoded using square brackets. +Data inside objects and lists is separated using commas:: + + items: [ + { "blocks": 36, "path" : "./src" }, + { "blocks": 40, "path" : "./bin" }, + { "blocks": 90, "path" : "./" } + ] + +HTML Output +~~~~~~~~~~~ + +HTML output is designed to allow the output to be rendered in a web +browser with minimal effort. Each piece of output data is rendered +inside a <div> element, with a class name related to the role of the +data. By using a small set of class attribute values, a CSS +stylesheet can render the HTML into rich text that mirrors the +traditional text content. + +Additional attributes can be enabled to provide more details about the +data, including data type, description, and an XPath location:: + + <div class="line"> + <div class="data" data-tag="blocks">36</div> + <div class="padding"> </div> + <div class="data" data-tag="path">./src</div> + </div> + <div class="line"> + <div class="data" data-tag="blocks">40</div> + <div class="padding"> </div> + <div class="data" data-tag="path">./bin</div> + </div> + <div class="line"> + <div class="data" data-tag="blocks">90</div> + <div class="padding"> </div> + <div class="data" data-tag="path">./</div> + </div> diff --git a/contrib/libxo/doc/getting.rst b/contrib/libxo/doc/getting.rst new file mode 100644 index 000000000000..1511aada5a1e --- /dev/null +++ b/contrib/libxo/doc/getting.rst @@ -0,0 +1,185 @@ + +.. index:: Getting libxo + +Getting libxo +============= + +libxo now ships as part of the FreeBSD Operating System (as of Release +11). + +libxo source code lives on github: + + https://github.com/Juniper/libxo + +The latest release of libxo is available at: + + https://github.com/Juniper/libxo/releases + +We're using `Semantic Versioning`_ to number our releases. libxo is +open source, distributed under the BSD license. We follow the +branching scheme from `A Successful Git Branching Model`_: +we do development under the "*develop*" branch, and release from +the "*master*" branch. To clone a developer tree, run the following +command:: + + git clone https://github.com/Juniper/libxo.git -b develop + +.. _Semantic Versioning: http://semver.org/spec/v2.0.0.html +.. _A Successful Git Branching Model: + http://nvie.com/posts/a-successful-git-branching-model + +Issues, problems, and bugs should be directly to the issues page on +our github site. + +Downloading libxo Source Code +----------------------------- + +You can retrieve the source for libxo in two ways: + +A. Use a "distfile" for a specific release. We use github to maintain + our releases. Visit the `release page`_ to see the list of + releases. To download the latest, look for the release witeh the + green "Latest release" button and the green "libxo-RELEASE.tar.gz" + button under that section. + +.. _release page: https://github.com/Juniper/libxo/releases + + After downloading that release's distfile, untar it as follows:: + + tar -zxf libxo-RELEASE.tar.gz + cd libxo-RELEASE + + .. admonition:: Solaris Users + + Note: for Solaris users, your "`tar`" command lacks the "-z" flag, + so you'll need to substitute "`gzip -dc $file | tar xf -`" instead + of "`tar -zxf $file`". + +B. Use the current build from github. This gives you the most recent + source code, which might be less stable than a specific release. To + build libxo from the git repo:: + + git clone https://github.com/Juniper/libxo.git + cd libxo + + .. admonition:: Be Aware + + The github repository does **not** contain the files generated by + "*autoreconf*", with the notable exception of the "*m4*" directory. + Since these files (depcomp, configure, missing, install-sh, etc) are + generated files, we keep them out of the source code repository. + + This means that if you download the a release distfile, these files + will be ready and you'll just need to run "configure", but if you + download the source code from svn, then you'll need to run + "*autoreconf*" by hand. This step is done for you by the "*setup.sh*" + script, described in the next section. + +.. _building: + +Building libxo +-------------- + +To build libxo, you'll need to set up the build, run the "*configure*" +script, run the "*make*" command, and run the regression tests. + +The following is a summary of the commands needed. These commands are +explained in detail in the rest of this section:: + + sh bin/setup.sh + cd build + ../configure + make + make test + sudo make install + +The following sections will walk through each of these steps with +additional details and options, but the above directions should be all +that's needed. + +Setting up the build +~~~~~~~~~~~~~~~~~~~~ + +.. admonition: Note + + If you downloaded a distfile, you can skip this step. + +Run the "*setup.sh*" script to set up the build. This script runs the +"*autoreconf*" command to generate the "*configure*" script and other +generated files:: + + sh bin/setup.sh + +Note: We're are currently using autoreconf version 2.69. + +Running the "configure" Script +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Configure (and autoconf in general) provides a means of building +software in diverse environments. Our configure script supports +a set of options that can be used to adjust to your operating +environment. Use "`configure --help`" to view these options. + +We use the "*build*" directory to keep object files and generated files +away from the source tree. + +To run the configure script, change into the "*build*" directory, and +run the "*configure*" script. Add any required options to the +"`../configure`" command line:: + + cd build + ../configure + +Expect to see the "*configure*" script generate the following error:: + + /usr/bin/rm: cannot remove `libtoolT': No such file or directory + +This error is harmless and can be safely ignored. + +By default, libxo installs architecture-independent files, including +extension library files, in the /usr/local directories. To specify an +installation prefix other than /usr/local for all installation files, +include the --prefix=prefix option and specify an alternate +location. To install just the extension library files in a different, +user-defined location, include the "*--with-extensions-dir=dir*" option +and specify the location where the extension libraries will live:: + + cd build + ../configure [OPTION]... [VAR=VALUE]... + +Running the "make" Command +++++++++++++++++++++++++++ + +Once the "*configure*" script is run, build the images using the +"`make`" command:: + + make + +Running the Regression Tests +++++++++++++++++++++++++++++ + +libxo includes a set of regression tests that can be run to ensure +the software is working properly. These test are optional, but will +help determine if there are any issues running libxo on your +machine. To run the regression tests:: + + make test + +Installing libxo +~~~~~~~~~~~~~~~~ + +Once the software is built, you'll need to install libxo using the +"`make install`" command. If you are the root user, or the owner of +the installation directory, simply issue the command:: + + make install + +If you are not the "*root*" user and are using the "*sudo*" package, use:: + + sudo make install + +Verify the installation by viewing the output of "`xo --version`":: + + % xo --version + libxo version 0.3.5-git-develop + xo version 0.3.5-git-develop diff --git a/contrib/libxo/doc/howto.rst b/contrib/libxo/doc/howto.rst new file mode 100644 index 000000000000..513572355bbc --- /dev/null +++ b/contrib/libxo/doc/howto.rst @@ -0,0 +1,394 @@ + +Howtos: Focused Directions +========================== + +This section provides task-oriented instructions for selected tasks. +If you have a task that needs instructions, please open a request as +an enhancement issue on github. + +Howto: Report bugs +------------------ + +libxo uses github to track bugs or request enhancements. Please use +the following URL: + + https://github.com/Juniper/libxo/issues + +Howto: Install libxo +-------------------- + +libxo is open source, under a new BSD license. Source code is +available on github, as are recent releases. To get the most +current release, please visit: + + https://github.com/Juniper/libxo/releases + +After downloading and untarring the source code, building involves the +following steps:: + + sh bin/setup.sh + cd build + ../configure + make + make test + sudo make install + +libxo uses a distinct "*build*" directory to keep generated files +separated from source files. + +.. index:: configure + +Use "`../configure --help`" to display available configuration +options, which include the following:: + + --enable-warnings Turn on compiler warnings + --enable-debug Turn on debugging + --enable-text-only Turn on text-only rendering + --enable-printflike Enable use of GCC __printflike attribute + --disable-libxo-options Turn off support for LIBXO_OPTIONS + --with-gettext=PFX Specify location of gettext installation + --with-libslax-prefix=PFX Specify location of libslax config + +Compiler warnings are a very good thing, but recent compiler version +have added some very pedantic checks. While every attempt is made to +keep libxo code warning-free, warnings are now optional. If you are +doing development work on libxo, it is required that you +use --enable-warnings to keep the code warning free, but most users +need not use this option. + +.. index:: --enable-text-only + +libxo provides the `--enable-text-only` option to reduce the +footprint of the library for smaller installations. XML, JSON, and +HTML rendering logic is removed. + +.. index:: --with-gettext + +The gettext library does not provide a simple means of learning its +location, but libxo will look for it in /usr and /opt/local. If +installed elsewhere, the installer will need to provide this +information using the "`--with-gettext=/dir/path`" option. + +.. index:: libslax + +libslax is not required by libxo; it contains the "oxtradoc" program +used to format documentation. + +For additional information, see :ref:`building`. + +Howto: Convert command line applications +---------------------------------------- + +Common question: How do I convert an existing command line application? + +There are four basic steps for converting command line application to +use libxo:: + +- Setting up the context +- Converting printf calls +- Creating hierarchy +- Converting error functions + +Setting up the context +~~~~~~~~~~~~~~~~~~~~~~ + +To use libxo, you'll need to include the "xo.h" header file in your +source code files:: + + #include <libxo/xo.h> + +In your main() function, you'll need to call xo_parse_args to handling +argument parsing (:ref:`xo_parse_args`). This function removes +libxo-specific arguments the program's argv and returns either the +number of remaining arguments or -1 to indicate an error:: + + int + main (int argc, char **argv) + { + argc = xo_parse_args(argc, argv); + if (argc < 0) + return argc; + .... + } + +.. index:: atexit +.. index:: xo_finish_atexit + +At the bottom of your main(), you'll need to call xo_finish() to +complete output processing for the default handle (:ref:`handles`). This +is required to flush internal information buffers. libxo provides the +xo_finish_atexit function that is suitable for use with the +:manpage:`atexit(3)` function:: + + atexit(xo_finish_atexit); + +Converting printf Calls +~~~~~~~~~~~~~~~~~~~~~~~ + +The second task is inspecting code for :manpage:`printf(3)` calls and +replacing them with xo_emit() calls. The format strings are similar +in task, but libxo format strings wrap output fields in braces. The +following two calls produce identical text output:: + + OLD:: + printf("There are %d %s events\n", count, etype); + + NEW:: + xo_emit("There are {:count/%d} {:event} events\n", count, etype); + +"count" and "event" are used as names for JSON and XML output. The +"count" field uses the format "%d" and "event" uses the default "%s" +format. Both are "value" roles, which is the default role. + +Since text outside of output fields is passed verbatim, other roles +are less important, but their proper use can help make output more +useful. The "note" and "label" roles allow HTML output to recognize +the relationship between text and the associated values, allowing +appropriate "hover" and "onclick" behavior. Using the "units" role +allows the presentation layer to perform conversions when needed. The +"warning" and "error" roles allows use of color and font to draw +attention to warnings. The "padding" role makes the use of vital +whitespace more clear (:ref:`padding-role`). + +The "*title*" role indicates the headings of table and sections. This +allows HTML output to use CSS to make this relationship more obvious:: + + OLD:: + printf("Statistics:\n"); + + NEW:: + xo_emit("{T:Statistics}:\n"); + +The "*color*" roles controls foreground and background colors, as well +as effects like bold and underline (see :ref:`color-role`):: + + NEW:: + xo_emit("{C:bold}required{C:}\n"); + +Finally, the start- and stop-anchor roles allow justification and +padding over multiple fields (see :ref:`anchor-role`):: + + OLD:: + snprintf(buf, sizeof(buf), "(%u/%u/%u)", min, ave, max); + printf("%30s", buf); + + NEW:: + xo_emit("{[:30}({:minimum/%u}/{:average/%u}/{:maximum/%u}{]:}", + min, ave, max); + +Creating Hierarchy +~~~~~~~~~~~~~~~~~~ + +Text output doesn't have any sort of hierarchy, but XML and JSON +require this. Typically applications use indentation to represent +these relationship:: + + OLD:: + printf("table %d\n", tnum); + for (i = 0; i < tmax; i++) { + printf(" %s %d\n", table[i].name, table[i].size); + } + + NEW:: + xo_emit("{T:/table %d}\n", tnum); + xo_open_list("table"); + for (i = 0; i < tmax; i++) { + xo_open_instance("table"); + xo_emit("{P: }{k:name} {:size/%d}\n", + table[i].name, table[i].size); + xo_close_instance("table"); + } + xo_close_list("table"); + +The open and close list functions are used before and after the list, +and the open and close instance functions are used before and after +each instance with in the list. + +Typically these developer looks for a "for" loop as an indication of +where to put these calls. + +In addition, the open and close container functions allow for +organization levels of hierarchy:: + + OLD:: + printf("Paging information:\n"); + printf(" Free: %lu\n", free); + printf(" Active: %lu\n", active); + printf(" Inactive: %lu\n", inactive); + + NEW:: + xo_open_container("paging-information"); + xo_emit("{P: }{L:Free: }{:free/%lu}\n", free); + xo_emit("{P: }{L:Active: }{:active/%lu}\n", active); + xo_emit("{P: }{L:Inactive: }{:inactive/%lu}\n", inactive); + xo_close_container("paging-information"); + +Converting Error Functions +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +libxo provides variants of the standard error and warning functions, +:manpage:`err(3)` and :manpage:`warn(3)`. There are two variants, one +for putting the errors on standard error, and the other writes the +errors and warnings to the handle using the appropriate encoding +style:: + + OLD:: + err(1, "cannot open output file: %s", file); + + NEW:: + xo_err(1, "cannot open output file: %s", file); + xo_emit_err(1, "cannot open output file: {:filename}", file); + +.. index:: xo_finish + +Call xo_finish +~~~~~~~~~~~~~~ + +One important item: call `xo_finish` at the end of your program so +ensure that all buffered data is written out. You can call it +explicitly call it, or use :manpage:`atexit(3)` to have +`xo_finish_atexit` called implicitly on exit:: + + OLD:: + exit(0); + + NEW:: + xo_finish(); + exit(0); + +Howto: Use "xo" in Shell Scripts +-------------------------------- + +.. admonition:: Needed + + Documentation is needed for this area. + +.. index:: Internationalization (i18n) +.. index:: gettext +.. index:: xopo + +.. _i18n: + +Howto: Internationalization (i18n) +----------------------------------------------- + + How do I use libxo to support internationalization? + +libxo allows format and field strings to be used a keys into message +catalogs to enable translation into a user's native language by +invoking the standard :manpage:`gettext(3)` functions. + +gettext setup is a bit complicated: text strings are extracted from +source files into "*portable object template*" (.pot) files using the +`xgettext` command. For each language, this template file is used as +the source for a message catalog in the "*portable object*" (.po) +format, which are translated by hand and compiled into "*machine +object*" (.mo) files using the `msgfmt` command. The .mo files are +then typically installed in the /usr/share/locale or +/opt/local/share/locale directories. At run time, the user's language +settings are used to select a .mo file which is searched for matching +messages. Text strings in the source code are used as keys to look up +the native language strings in the .mo file. + +Since the xo_emit format string is used as the key into the message +catalog, libxo removes unimportant field formatting and modifiers from +the format string before use so that minor formatting changes will not +impact the expensive translation process. We don't want a developer +change such as changing "/%06d" to "/%08d" to force hand inspection of +all .po files. The simplified version can be generated for a single +message using the `xopo -s $text` command, or an entire .pot can be +translated using the `xopo -f $input -o $output` command:: + + EXAMPLE: + % xopo -s "There are {:count/%u} {:event/%.6s} events\n" + There are {:count} {:event} events\n + + Recommended workflow: + # Extract text messages + xgettext --default-domain=foo --no-wrap \ + --add-comments --keyword=xo_emit --keyword=xo_emit_h \ + --keyword=xo_emit_warn -C -E -n --foreign-user \ + -o foo.pot.raw foo.c + + # Simplify format strings for libxo + xopo -f foo.pot.raw -o foo.pot + + # For a new language, just copy the file + cp foo.pot po/LC/my_lang/foo.po + + # For an existing language: + msgmerge --no-wrap po/LC/my_lang/foo.po \ + foo.pot -o po/LC/my_lang/foo.po.new + + # Now the hard part: translate foo.po using tools + # like poedit or emacs' po-mode + + # Compile the finished file; Use of msgfmt's "-v" option is + # strongly encouraged, so that "fuzzy" entries are reported. + msgfmt -v -o po/my_lang/LC_MESSAGES/foo.mo po/my_lang/foo.po + + # Install the .mo file + sudo cp po/my_lang/LC_MESSAGES/foo.mo \ + /opt/local/share/locale/my_lang/LC_MESSAGE/ + +Once these steps are complete, you can use the `gettext` command to +test the message catalog:: + + gettext -d foo -e "some text" + +i18n and xo_emit +~~~~~~~~~~~~~~~~ + +There are three features used in libxo used to support i18n: + +- The "{G:}" role looks for a translation of the format string. +- The "{g:}" modifier looks for a translation of the field. +- The "{p:}" modifier looks for a pluralized version of the field. + +Together these three flags allows a single function call to give +native language support, as well as libxo's normal XML, JSON, and HTML +support:: + + printf(gettext("Received %zu %s from {g:server} server\n"), + counter, ngettext("byte", "bytes", counter), + gettext("web")); + + xo_emit("{G:}Received {:received/%zu} {Ngp:byte,bytes} " + "from {g:server} server\n", counter, "web"); + +libxo will see the "{G:}" role and will first simplify the format +string, removing field formats and modifiers:: + + "Received {:received} {N:byte,bytes} from {:server} server\n" + +libxo calls :manpage:`gettext(3)` with that string to get a localized +version. If your language were *Pig Latin*, the result might look +like:: + + "Eceivedray {:received} {N:byte,bytes} omfray " + "{:server} erversay\n" + +Note the field names do not change and they should not be translated. +The contents of the note ("byte,bytes") should also not be translated, +since the "g" modifier will need the untranslated value as the key for +the message catalog. + +The field "{g:server}" requests the rendered value of the field be +translated using :manpage:`gettext(3)`. In this example, "web" would +be used. + +The field "{Ngp:byte,bytes}" shows an example of plural form using the +"{p:}" modifier with the "{g:}" modifier. The base singular and plural +forms appear inside the field, separated by a comma. At run time, +libxo uses the previous field's numeric value to decide which form to +use by calling :manpage:`ngettext(3)`. + +If a domain name is needed, it can be supplied as the content of the +{G:} role. Domain names remain in use throughout the format string +until cleared with another domain name:: + + printf(dgettext("dns", "Host %s not found: %d(%s)\n"), + name, errno, dgettext("strerror", strerror(errno))); + + xo_emit("{G:dns}Host {:hostname} not found: " + "%d({G:strerror}{g:%m})\n", name, errno); diff --git a/contrib/libxo/doc/index.rst b/contrib/libxo/doc/index.rst new file mode 100644 index 000000000000..116be40533ea --- /dev/null +++ b/contrib/libxo/doc/index.rst @@ -0,0 +1,54 @@ +.. # + # Copyright (c) 2014, Juniper Networks, Inc. + # All rights reserved. + # This SOFTWARE is licensed under the LICENSE provided in the + # ../Copyright file. By downloading, installing, copying, or + # using the SOFTWARE, you agree to be bound by the terms of that + # LICENSE. + # Phil Shafer, July 2014 + # + +.. default-role:: code + +libxo - A Library for Generating Text, XML, JSON, and HTML Output +=================================================================== + +The libxo library allows an application to generate text, XML, JSON, +and HTML output, suitable for both command line use and for web +applications. The application decides at run time which output style +should be produced. By using libxo, a single source code path can +emit multiple styles of output using command line options to select +the style, along with optional behaviors. libxo includes support for +multiple output streams, pluralization, color, syslog, +:manpage:`humanized(3)` output, internationalization, and UTF-8. The +library aims to minimize the cost of migrating code to libxo. + +libxo ships as part of FreeBSD. + +.. toctree:: + :maxdepth: 3 + :caption: Documentation Contents: + + intro + getting + formatting + options + format-strings + field-roles + field-modifiers + field-formatting + api + encoders + xo + xolint + xohtml + xopo + faq + howto + example + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/contrib/libxo/doc/intro.rst b/contrib/libxo/doc/intro.rst new file mode 100644 index 000000000000..40b3a4f4a5de --- /dev/null +++ b/contrib/libxo/doc/intro.rst @@ -0,0 +1,90 @@ + +Introducing libxo +================= + +The libxo library allows an application to generate text, XML, JSON, +and HTML output using a common set of function calls. The application +decides at run time which output style should be produced. The +application calls a function "xo_emit" to product output that is +described in a format string. A "field descriptor" tells libxo what +the field is and what it means. Each field descriptor is placed in +braces with printf-like :ref:`format-strings`:: + + xo_emit(" {:lines/%7ju} {:words/%7ju} " + "{:characters/%7ju} {d:filename/%s}\n", + linect, wordct, charct, file); + +Each field can have a role, with the 'value' role being the default, +and the role tells libxo how and when to render that field (see +:ref:`field-roles` for details). Modifiers change how the field is +rendered in different output styles (see :ref:`field-modifiers` for +details. Output can then be generated in various style, using the +"--libxo" option:: + + % wc /etc/motd + 25 165 1140 /etc/motd + % wc --libxo xml,pretty,warn /etc/motd + <wc> + <file> + <lines>25</lines> + <words>165</words> + <characters>1140</characters> + <filename>/etc/motd</filename> + </file> + </wc> + % wc --libxo json,pretty,warn /etc/motd + { + "wc": { + "file": [ + { + "lines": 25, + "words": 165, + "characters": 1140, + "filename": "/etc/motd" + } + ] + } + } + % wc --libxo html,pretty,warn /etc/motd + <div class="line"> + <div class="text"> </div> + <div class="data" data-tag="lines"> 25</div> + <div class="text"> </div> + <div class="data" data-tag="words"> 165</div> + <div class="text"> </div> + <div class="data" data-tag="characters"> 1140</div> + <div class="text"> </div> + <div class="data" data-tag="filename">/etc/motd</div> + </div> + +Same code path, same format strings, same information, but it's +rendered in distinct styles based on run-time flags. + +.. admonition:: Tale of Two Code Paths + + You want to prepare for the future, but you need to live in the + present. You'd love a flying car, but need to get work done today. + You want to support features like XML, JSON, and HTML rendering to + allow integration with NETCONF, REST, and web browsers, but you need + to make text output for command line users. + + And you don't want multiple code paths that can't help but get out + of sync:: + + /* None of this "if (xml) {... } else {...}" logic */ + if (xml) { + /* some code to make xml */ + } else { + /* other code to make text */ + /* oops! forgot to add something on both clauses! */ + } + + /* And ifdefs are right out. */ + #ifdef MAKE_XML + /* icky */ + #else + /* pooh */ + #endif + + But you'd really, really like all the fancy features that modern + encoding formats can provide. libxo can help. diff --git a/contrib/libxo/doc/options.rst b/contrib/libxo/doc/options.rst new file mode 100644 index 000000000000..79cd360a1f44 --- /dev/null +++ b/contrib/libxo/doc/options.rst @@ -0,0 +1,184 @@ + +.. index:: --libxo +.. index:: Options + +.. _options: + +Command-line Arguments +====================== + +libxo uses command line options to trigger rendering behavior. There +are multiple conventions for passing options, all using the +"`--libxo`" option:: + + --libxo <options> + --libxo=<options> + --libxo:<brief-options> + +The *brief-options* is a series of single letter abbrevations, where +the *options* is a comma-separated list of words. Both provide access +to identical functionality. The following invocations are all +identical in outcome:: + + my-app --libxo warn,pretty arg1 + my-app --libxo=warn,pretty arg1 + my-app --libxo:WP arg1 + +Programs using libxo are expecting to call the xo_parse_args function +to parse these arguments. See :ref:`xo_parse_args` for details. + +Option Keywords +--------------- + +Options is a comma-separated list of tokens that correspond to output +styles, flags, or features: + + =============== ======================================================= + Token Action + =============== ======================================================= + color Enable colors/effects for display styles (TEXT, HTML) + colors=xxxx Adjust color output values + dtrt Enable "Do The Right Thing" mode + flush Flush after every libxo function call + flush-line Flush after every line (line-buffered) + html Emit HTML output + indent=xx Set the indentation level + info Add info attributes (HTML) + json Emit JSON output + keys Emit the key attribute for keys (XML) + log-gettext Log (via stderr) each gettext(3) string lookup + log-syslog Log (via stderr) each syslog message (via xo_syslog) + no-humanize Ignore the {h:} modifier (TEXT, HTML) + no-locale Do not initialize the locale setting + no-retain Prevent retaining formatting information + no-top Do not emit a top set of braces (JSON) + not-first Pretend the 1st output item was not 1st (JSON) + pretty Emit pretty-printed output + retain Force retaining formatting information + text Emit TEXT output + underscores Replace XML-friendly "-"s with JSON friendly "_"s + units Add the 'units' (XML) or 'data-units (HTML) attribute + warn Emit warnings when libxo detects bad calls + warn-xml Emit warnings in XML + xml Emit XML output + xpath Add XPath expressions (HTML) + =============== ======================================================= + +Most of these option are simple and direct, but some require +additional details: + +- "colors" is described in :ref:`color-mapping`. +- "flush-line" performs line buffering, even when the output is not + directed to a TTY device. +- "info" generates additional data for HTML, encoded in attributes + using names that state with "data-". +- "keys" adds a "key" attribute for XML output to indicate that a leaf + is an identifier for the list member. +- "no-humanize" avoids "humanizing" numeric output (see + :ref:`humanize-modifier` for details). +- "no-locale" instructs libxo to avoid translating output to the + current locale. +- "no-retain" disables the ability of libxo to internally retain + "compiled" information about formatting strings (see :ref:`retain` + for details). +- "underscores" can be used with JSON output to change XML-friendly + names with dashes into JSON-friendly name with underscores. +- "warn" allows libxo to emit warnings on stderr when application code + make incorrect calls. +- "warn-xml" causes those warnings to be placed in XML inside the + output. + +Brief Options +------------- + +The brief options are simple single-letter aliases to the normal +keywords, as detailed below: + + ======== ============================================= + Option Action + ======== ============================================= + c Enable color/effects for TEXT/HTML + F Force line-buffered flushing + H Enable HTML output (XO_STYLE_HTML) + I Enable info output (XOF_INFO) + i<num> Indent by <number> + J Enable JSON output (XO_STYLE_JSON) + k Add keys to XPATH expressions in HTML + n Disable humanization (TEXT, HTML) + P Enable pretty-printed output (XOF_PRETTY) + T Enable text output (XO_STYLE_TEXT) + U Add units to HTML output + u Change "-"s to "_"s in element names (JSON) + W Enable warnings (XOF_WARN) + X Enable XML output (XO_STYLE_XML) + x Enable XPath data (XOF_XPATH) + ======== ============================================= + +.. index:: Colors + +.. _color-mapping: + +Color Mapping +------------- + +The "colors" option takes a value that is a set of mappings from the +pre-defined set of colors to new foreground and background colors. +The value is a series of "fg/bg" values, separated by a "+". Each +pair of "fg/bg" values gives the colors to which a basic color is +mapped when used as a foreground or background color. The order is +the mappings is: + +- black +- red +- green +- yellow +- blue +- magenta +- cyan +- white + +Pairs may be skipped, leaving them mapped as normal, as are missing +pairs or single colors. + +For example consider the following xo_emit call:: + + xo_emit("{C:fg-red,bg-green}Merry XMas!!{C:}\n"); + +To turn all colored output to red-on-blue, use eight pairs of +"red/blue" mappings separated by plus signs ("+"):: + + --libxo colors=red/blue+red/blue+red/blue+red/blue+\ + red/blue+red/blue+red/blue+red/blue + +To turn the red-on-green text to magenta-on-cyan, give a "magenta" +foreground value for red (the second mapping) and a "cyan" background +to green (the third mapping):: + + --libxo colors=+magenta+/cyan + +Consider the common situation where blue output looks unreadable on a +terminal session with a black background. To turn both "blue" +foreground and background output to "yellow", give only the fifth +mapping, skipping the first four mappings with bare plus signs ("+"):: + + --libxo colors=++++yellow/yellow + +Encoders +-------- + +In addition to the four "built-in" formats, libxo supports an +extensible mechanism for adding encoders. These are activated +using the "encoder" keyword:: + + --libxo encoder=cbor + +The encoder can include encoder-specific options, separated by either +colons (":") or plus signs ("+"): + + --libxo encoder=csv+path=filesystem+leaf=name+no-header + --libxo encoder=csv:path=filesystem:leaf=name:no-header + +For brevity, the string "@" can be used in place of the string +"encoder=". + + df --libxo @csv:no-header diff --git a/contrib/libxo/doc/top-link.html.in b/contrib/libxo/doc/top-link.html.in new file mode 100644 index 000000000000..17825fe4c180 --- /dev/null +++ b/contrib/libxo/doc/top-link.html.in @@ -0,0 +1,9 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Refresh" content="0; url=@LIBXO_VERSION@/html/index.html" /> + </head> + <body> + <p>The current libxo version is <a href="@LIBXO_VERSION@/html/index.html">@LIBXO_VERSION@</a>.</p> + </body> +</html> diff --git a/contrib/libxo/doc/xo.rst b/contrib/libxo/doc/xo.rst new file mode 100644 index 000000000000..5a9e8819122e --- /dev/null +++ b/contrib/libxo/doc/xo.rst @@ -0,0 +1,234 @@ +.. index:: --libxo, xo +.. _xo: + +The "xo" Utility +================ + +The `xo` utility allows command line access to the functionality of +the libxo library. Using `xo`, shell scripts can emit XML, JSON, and +HTML using the same commands that emit text output. + +The style of output can be selected using a specific option: "-X" for +XML, "-J" for JSON, "-H" for HTML, or "-T" for TEXT, which is the +default. The "--style <style>" option can also be used. The standard +set of "--libxo" options are available (see :ref:`options`), as well +as the :ref:`LIBXO_OPTIONS <libxo-options>` environment variable. + +The `xo` utility accepts a format string suitable for `xo_emit` and +a set of zero or more arguments used to supply data for that string:: + + xo "The {k:name} weighs {:weight/%d} pounds.\n" fish 6 + + TEXT: + The fish weighs 6 pounds. + + XML: + <name>fish</name> + <weight>6</weight> + + JSON: + "name": "fish", + "weight": 6 + + HTML: + <div class="line"> + <div class="text">The </div> + <div class="data" data-tag="name">fish</div> + <div class="text"> weighs </div> + <div class="data" data-tag="weight">6</div> + <div class="text"> pounds.</div> + </div> + +The `--wrap $path` option can be used to wrap emitted content in a +specific hierarchy. The path is a set of hierarchical names separated +by the '/' character:: + + xo --wrap top/a/b/c '{:tag}' value + + XML: + <top> + <a> + <b> + <c> + <tag>value</tag> + </c> + </b> + </a> + </top> + + JSON: + "top": { + "a": { + "b": { + "c": { + "tag": "value" + } + } + } + } + +The `--open $path` and `--close $path` can be used to emit +hierarchical information without the matching close and open +tag. This allows a shell script to emit open tags, data, and +then close tags. The `--depth` option may be used to set the +depth for indentation. The `--leading-xpath` may be used to +prepend data to the XPath values used for HTML output style:: + + EXAMPLE: + #!/bin/sh + xo --open top/data + xo --depth 2 '{:tag}' value + xo --close top/data + + XML: + <top> + <data> + <tag>value</tag> + </data> + </top> + + JSON: + "top": { + "data": { + "tag": "value" + } + } + +When making partial lines of output (where the format string does not +include a newline), use the `--continuation` option to let secondary +invocations know they are adding data to an existing line. + +When emitting a series of objects, use the `--not-first` option to +ensure that any details from the previous object (e.g. commas in JSON) +are handled correctly. + +Use the `--top-wrap` option to ensure any top-level object details are +handled correctly, e.g. wrap the entire output in a top-level set of +braces for JSON output. + +:: + + EXAMPLE: + #!/bin/sh + xo --top-wrap --open top/data + xo --depth 2 'First {:tag} ' value1 + xo --depth 2 --continuation 'and then {:tag}\n' value2 + xo --top-wrap --close top/data + + TEXT: + First value1 and then value2 + + HTML: + <div class="line"> + <div class="text">First </div> + <div class="data" data-tag="tag">value1</div> + <div class="text"> </div> + <div class="text">and then </div> + <div class="data" data-tag="tag">value2</div> + </div> + + XML: + <top> + <data> + <tag>value1</tag> + <tag>value2</tag> + </data> + </top> + + JSON: + { + "top": { + "data": { + "tag": "value1", + "tag": "value2" + } + } + } + +Lists and Instances +------------------- + +A "*list*" is set of one or more instances that appear under the same +parent. The instances contain details about a specific object. One +can think of instances as objects or records. A call is needed to +open and close the list, while a distinct call is needed to open and +close each instance of the list. + +Use the `--open-list` and `--open-instances` to open lists and +instances. Use the `--close-list` and `--close-instances` to close +them. Each of these options take a `name` parameter, providing the +name of the list and instance. + +In the following example, a list named "machine" is created with three +instances:: + + opts="--json" + xo $opts --open-list machine + NF= + for name in red green blue; do + xo $opts --depth 1 $NF --open-instance machine + xo $opts --depth 2 "Machine {k:name} has {:memory}\n" $name 55 + xo $opts --depth 1 --close-instance machine + NF=--not-first + done + xo $opts $NF --close-list machine + +The normal `libxo` functions use a state machine to help these +transitions, but since each `xo` command is invoked independent of the +previous calls, the state must be passed in explicitly via these +command line options. + +The `--instance` option can be used to treat a single `xo` invocation +as an instance with the given set of fields:: + + % xo --libxo:XP --instance foo 'The {:product} is {:status}\n' stereo "in route" + <foo> + <product>stereo</product> + <status>in route</status> + </foo> + +Command Line Options +-------------------- + +:: + + Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output) + +Example +------- + +:: + + % xo 'The {:product} is {:status}\n' stereo "in route" + The stereo is in route + % xo -p -X 'The {:product} is {:status}\n' stereo "in route" + <product>stereo</product> + <status>in route</status> + % xo --libxo xml,pretty 'The {:product} is {:status}\n' stereo "in route" + <product>stereo</product> + <status>in route</status> diff --git a/contrib/libxo/doc/xohtml.rst b/contrib/libxo/doc/xohtml.rst new file mode 100644 index 000000000000..f92e63f4d9c1 --- /dev/null +++ b/contrib/libxo/doc/xohtml.rst @@ -0,0 +1,30 @@ +.. index:: xohtml + +.. _xohtml: + +xohtml +====== + +`xohtml` is a tool for turning the output of libxo-enabled commands into +html files suitable for display in modern HTML web browsers. It can +be used to test and debug HTML output, as well as to make the user +ache to escape the world of '70s terminal devices. + +`xohtml` is given a command, either on the command line or via the "-c" +option. If not command is given, standard input is used. The +command's output is wrapped in HTML tags, with references to +supporting CSS and Javascript files, and written to standard output or +the file given in the "-f" option. The "-b" option can be used to +provide an alternative base path for the support files: + + ============== =================================================== + Option Meaning + ============== =================================================== + -b <base> Base path for finding css/javascript files + -c <command> Command to execute + -f <file> Output file name + ============== =================================================== + +The "-c" option takes a full command with arguments, including +any libxo options needed to generate html (`--libxo=html`). This +value must be quoted if it consists of multiple tokens. diff --git a/contrib/libxo/doc/xolint-errors.rst b/contrib/libxo/doc/xolint-errors.rst new file mode 100644 index 000000000000..c3e518b9cddf --- /dev/null +++ b/contrib/libxo/doc/xolint-errors.rst @@ -0,0 +1,444 @@ +'A percent sign appearing in text is a literal' ++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "A percent sign appearing in text is a literal" can be caused by code like: + +:: + + xo_emit("cost: %d", cost); + +This code should be replaced with code like: + +:: + + xo_emit("{L:cost}: {:cost/%d}", cost); + +This can be a bit surprising and could be a field that was not +properly converted to a libxo-style format string. + + +'Unknown long name for role/modifier' ++++++++++++++++++++++++++++++++++++++ + +The message "Unknown long name for role/modifier" can be caused by code like: + +:: + + xo_emit("{,humanization:value}", value); + +This code should be replaced with code like: + +:: + + xo_emit("{,humanize:value}", value); + +The hn-* modifiers (hn-decimal, hn-space, hn-1000) +are only valid for fields with the {h:} modifier. + + +'Last character before field definition is a field type' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Last character before field definition is a field type" can be caused by code like: +A common typo: + +:: + + xo_emit("{T:Min} T{:Max}"); + +This code should be replaced with code like: + +:: + + xo_emit("{T:Min} {T:Max}"); + +Twiddling the "{" and the field role is a common typo. + + +'Encoding format uses different number of arguments' +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Encoding format uses different number of arguments" can be caused by code like: + +:: + + xo_emit("{:name/%6.6s %%04d/%s}", name, number); + +This code should be replaced with code like: + +:: + + xo_emit("{:name/%6.6s %04d/%s-%d}", name, number); + +Both format should consume the same number of arguments off the stack + + +'Only one field role can be used' ++++++++++++++++++++++++++++++++++ + +The message "Only one field role can be used" can be caused by code like: + +:: + + xo_emit("{LT:Max}"); + +This code should be replaced with code like: + +:: + + xo_emit("{T:Max}"); + +'Potential missing slash after C, D, N, L, or T with format' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Potential missing slash after C, D, N, L, or T with format" can be caused by code like: + +:: + + xo_emit("{T:%6.6s}\n", "Max"); + +This code should be replaced with code like: + +:: + + xo_emit("{T:/%6.6s}\n", "Max"); + +The "%6.6s" will be a literal, not a field format. While +it's possibly valid, it's likely a missing "/". + + +'An encoding format cannot be given (roles: DNLT)' +++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "An encoding format cannot be given (roles: DNLT)" can be caused by code like: + +:: + + xo_emit("{T:Max//%s}", "Max"); + +Fields with the C, D, N, L, and T roles are not emitted in +the 'encoding' style (JSON, XML), so an encoding format +would make no sense. + + +'Format cannot be given when content is present (roles: CDLN)' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Format cannot be given when content is present (roles: CDLN)" can be caused by code like: + +:: + + xo_emit("{N:Max/%6.6s}", "Max"); + +Fields with the C, D, L, or N roles can't have both +static literal content ("{L:Label}") and a +format ("{L:/%s}"). +This error will also occur when the content has a backslash +in it, like "{N:Type of I/O}"; backslashes should be escaped, +like "{N:Type of I\\/O}". Note the double backslash, one for +handling 'C' strings, and one for libxo. + + +'Field has color without fg- or bg- (role: C)' +++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Field has color without fg- or bg- (role: C)" can be caused by code like: + +:: + + xo_emit("{C:green}{:foo}{C:}", x); + +This code should be replaced with code like: + +:: + + xo_emit("{C:fg-green}{:foo}{C:}", x); + +Colors must be prefixed by either "fg-" or "bg-". + + +'Field has invalid color or effect (role: C)' ++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Field has invalid color or effect (role: C)" can be caused by code like: + +:: + + xo_emit("{C:fg-purple,bold}{:foo}{C:gween}", x); + +This code should be replaced with code like: + +:: + + xo_emit("{C:fg-red,bold}{:foo}{C:fg-green}", x); + +The list of colors and effects are limited. The +set of colors includes default, black, red, green, +yellow, blue, magenta, cyan, and white, which must +be prefixed by either "fg-" or "bg-". Effects are +limited to bold, no-bold, underline, no-underline, +inverse, no-inverse, normal, and reset. Values must +be separated by commas. + + +'Field has humanize modifier but no format string' +++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Field has humanize modifier but no format string" can be caused by code like: + +:: + + xo_emit("{h:value}", value); + +This code should be replaced with code like: + +:: + + xo_emit("{h:value/%d}", value); + +Humanization is only value for numbers, which are not +likely to use the default format ("%s"). + + +'Field has hn-* modifier but not 'h' modifier' +++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Field has hn-* modifier but not 'h' modifier" can be caused by code like: + +:: + + xo_emit("{,hn-1000:value}", value); + +This code should be replaced with code like: + +:: + + xo_emit("{h,hn-1000:value}", value); + +The hn-* modifiers (hn-decimal, hn-space, hn-1000) +are only valid for fields with the {h:} modifier. + + +'Value field must have a name (as content)")' ++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Value field must have a name (as content)")" can be caused by code like: + +:: + + xo_emit("{:/%s}", "value"); + +This code should be replaced with code like: + +:: + + xo_emit("{:tag-name/%s}", "value"); + +The field name is used for XML and JSON encodings. These +tags names are static and must appear directly in the +field descriptor. + + +'Use hyphens, not underscores, for value field name' +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Use hyphens, not underscores, for value field name" can be caused by code like: + +:: + + xo_emit("{:no_under_scores}", "bad"); + +This code should be replaced with code like: + +:: + + xo_emit("{:no-under-scores}", "bad"); + +Use of hyphens is traditional in XML, and the XOF_UNDERSCORES +flag can be used to generate underscores in JSON, if desired. +But the raw field name should use hyphens. + + +'Value field name cannot start with digit' +++++++++++++++++++++++++++++++++++++++++++ + +The message "Value field name cannot start with digit" can be caused by code like: + +:: + + xo_emit("{:10-gig/}"); + +This code should be replaced with code like: + +:: + + xo_emit("{:ten-gig/}"); + +XML element names cannot start with a digit. + + +'Value field name should be lower case' ++++++++++++++++++++++++++++++++++++++++ + +The message "Value field name should be lower case" can be caused by code like: + +:: + + xo_emit("{:WHY-ARE-YOU-SHOUTING}", "NO REASON"); + +This code should be replaced with code like: + +:: + + xo_emit("{:why-are-you-shouting}", "no reason"); + +Lower case is more civilized. Even TLAs should be lower case +to avoid scenarios where the differences between "XPath" and +"Xpath" drive your users crazy. Lower case rules the seas. + + +'Value field name should be longer than two characters' ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Value field name should be longer than two characters" can be caused by code like: + +:: + + xo_emit("{:x}", "mumble"); + +This code should be replaced with code like: + +:: + + xo_emit("{:something-meaningful}", "mumble"); + +Field names should be descriptive, and it's hard to +be descriptive in less than two characters. Consider +your users and try to make something more useful. +Note that this error often occurs when the field type +is placed after the colon ("{:T/%20s}"), instead of before +it ("{T:/20s}"). + + +'Value field name contains invalid character' ++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Value field name contains invalid character" can be caused by code like: + +:: + + xo_emit("{:cost-in-$$/%u}", 15); + +This code should be replaced with code like: + +:: + + xo_emit("{:cost-in-dollars/%u}", 15); + +An invalid character is often a sign of a typo, like "{:]}" +instead of "{]:}". Field names are restricted to lower-case +characters, digits, and hyphens. + + +'decoration field contains invalid character' ++++++++++++++++++++++++++++++++++++++++++++++ + +The message "decoration field contains invalid character" can be caused by code like: + +:: + + xo_emit("{D:not good}"); + +This code should be replaced with code like: + +:: + + xo_emit("{D:((}{:good}{D:))}", "yes"); + +This is minor, but fields should use proper roles. Decoration +fields are meant to hold punctuation and other characters used +to decorate the content, typically to make it more readable +to human readers. + + +'Anchor content should be decimal width' +++++++++++++++++++++++++++++++++++++++++ + +The message "Anchor content should be decimal width" can be caused by code like: + +:: + + xo_emit("{[:mumble}"); + +This code should be replaced with code like: + +:: + + xo_emit("{[:32}"); + +Anchors need an integer value to specify the width of +the set of anchored fields. The value can be positive +(for left padding/right justification) or negative (for +right padding/left justification) and can appear in +either the start or stop anchor field descriptor. + + +'Anchor format should be "%d"' +++++++++++++++++++++++++++++++ + +The message "Anchor format should be "%d"" can be caused by code like: + +:: + + xo_emit("{[:/%s}"); + +This code should be replaced with code like: + +:: + + xo_emit("{[:/%d}"); + +Anchors only grok integer values, and if the value is not static, +if must be in an 'int' argument, represented by the "%d" format. +Anything else is an error. + + +'Anchor cannot have both format and encoding format")' +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The message "Anchor cannot have both format and encoding format")" can be caused by code like: + +:: + + xo_emit("{[:32/%d}"); + +This code should be replaced with code like: + +:: + + xo_emit("{[:32}"); + +Anchors can have a static value or argument for the width, +but cannot have both. + + +'Max width only valid for strings' +++++++++++++++++++++++++++++++++++ + +The message "Max width only valid for strings" can be caused by code like: + +:: + + xo_emit("{:tag/%2.4.6d}", 55); + +This code should be replaced with code like: + +:: + + xo_emit("{:tag/%2.6d}", 55); + +libxo allows a true 'max width' in addition to the traditional +printf-style 'max number of bytes to use for input'. But this +is supported only for string values, since it makes no sense +for non-strings. This error may occur from a typo, +like "{:tag/%6..6d}" where only one period should be used. diff --git a/contrib/libxo/doc/xolint.rst b/contrib/libxo/doc/xolint.rst new file mode 100644 index 000000000000..739fa18558f7 --- /dev/null +++ b/contrib/libxo/doc/xolint.rst @@ -0,0 +1,40 @@ +====== +xolint +====== + +`xolint` is a tool for reporting common mistakes in format strings +in source code that invokes `xo_emit`. It allows these errors +to be diagnosed at build time, rather than waiting until runtime. + +`xolint` takes the one or more C files as arguments, and reports +and errors, warning, or informational messages as needed: + + ============ =================================================== + Option Meaning + ============ =================================================== + -c Invoke 'cpp' against the input file + -C <flags> Flags that are passed to 'cpp + -d Enable debug output + -D Generate documentation for all xolint messages + -I Generate info table code + -p Print the offending lines after the message + -V Print vocabulary of all field names + -X Extract samples from xolint, suitable for testing + ============ =================================================== + +The output message will contain the source filename and line number, the +class of the message, the message, and, if -p is given, the +line that contains the error:: + + % xolint.pl -t xolint.c + xolint.c: 16: error: anchor format should be "%d" + 16 xo_emit("{[:/%s}"); + +The "-I" option will generate a table of `xo_info_t`_ structures, +suitable for inclusion in source code. + +.. _xo_info_t: :ref:`field-information` + +The "-V" option does not report errors, but prints a complete list of +all field names, sorted alphabetically. The output can help spot +inconsistencies and spelling errors. diff --git a/contrib/libxo/doc/xopo.rst b/contrib/libxo/doc/xopo.rst new file mode 100644 index 000000000000..b10c0da36e50 --- /dev/null +++ b/contrib/libxo/doc/xopo.rst @@ -0,0 +1,45 @@ + +xopo +==== + +The `xopo` utility filters ".pot" files generated by the +:manpage:`xgettext(1)` utility to remove formatting information +suitable for use with the "{G:}" modifier. This means that when the +developer changes the formatting portion of the field definitions, or +the fields modifiers, the string passed to :manpage:`gettext(3)` is +unchanged, avoiding the expense of updating any existing translation +files (".po" files). + +The syntax for the xopo command is one of two forms; it can be used as +a filter for processing a .po or .pot file, rewriting the "*msgid*" +strings with a simplified message string. In this mode, the input is +either standard input or a file given by the "-f" option, and the +output is either standard output or a file given by the "-o" option. + +In the second mode, a simple message given using the "-s" option on +the command, and the simplified version of that message is printed on +stdout: + + =========== ================================= + Option Meaning + =========== ================================= + -o <file> Output file name + -f <file> Use the given .po file as input + -s <text> Simplify a format string + =========== ================================= + +:: + + EXAMPLE: + % xopo -s "There are {:count/%u} {:event/%.6s} events\n" + There are {:count} {:event} events\n + + % xgettext --default-domain=foo --no-wrap \ + --add-comments --keyword=xo_emit --keyword=xo_emit_h \ + --keyword=xo_emit_warn -C -E -n --foreign-user \ + -o foo.pot.raw foo.c + % xopo -f foo.pot.raw -o foo.pot + +Use of the `--no-wrap` option for `xgettext` is required to +ensure that incoming msgid strings are not wrapped across multiple +lines. diff --git a/contrib/libxo/encoder/Makefile.am b/contrib/libxo/encoder/Makefile.am new file mode 100644 index 000000000000..6eb555703731 --- /dev/null +++ b/contrib/libxo/encoder/Makefile.am @@ -0,0 +1,12 @@ +# +# Copyright 2015-2019, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +SUBDIRS = \ + cbor \ + csv \ + test diff --git a/contrib/libxo/encoder/cbor/Makefile.am b/contrib/libxo/encoder/cbor/Makefile.am new file mode 100644 index 000000000000..7ce44e09fedd --- /dev/null +++ b/contrib/libxo/encoder/cbor/Makefile.am @@ -0,0 +1,51 @@ +# +# $Id$ +# +# Copyright 2015, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +if LIBXO_WARNINGS_HIGH +LIBXO_WARNINGS = HIGH +endif +if HAVE_GCC +GCC_WARNINGS = yes +endif +include ${top_srcdir}/warnings.mk + +enc_cborincdir = ${includedir}/libxo + +AM_CFLAGS = \ + -I${top_srcdir}/libxo \ + -I${top_builddir}/libxo \ + ${WARNINGS} + +LIBNAME = libenc_cbor +pkglib_LTLIBRARIES = libenc_cbor.la +LIBS = \ + -L${top_builddir}/libxo -lxo + +LDADD = ${top_builddir}/libxo/libxo.la + +libenc_cbor_la_SOURCES = \ + enc_cbor.c + +pkglibdir = ${XO_ENCODERDIR} + +UGLY_NAME = cbor.enc + +install-exec-hook: + @DLNAME=`sh -c '. ./libenc_cbor.la ; echo $$dlname'` ; \ + if [ x"$$DLNAME" = x ]; \ + then DLNAME=${LIBNAME}.${XO_LIBEXT}; fi ; \ + if [ "$(build_os)" = "cygwin" ]; \ + then DLNAME="../bin/$$DLNAME"; fi ; \ + echo Install link $$DLNAME "->" ${UGLY_NAME} "..." ; \ + mkdir -p ${DESTDIR}${XO_ENCODERDIR} ; \ + cd ${DESTDIR}${XO_ENCODERDIR} \ + && chmod +w . \ + && rm -f ${UGLY_NAME} \ + && ${LN_S} $$DLNAME ${UGLY_NAME} diff --git a/contrib/libxo/encoder/cbor/enc_cbor.c b/contrib/libxo/encoder/cbor/enc_cbor.c new file mode 100644 index 000000000000..28ca0f7ea3e1 --- /dev/null +++ b/contrib/libxo/encoder/cbor/enc_cbor.c @@ -0,0 +1,366 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, August 2015 + */ + +/* + * CBOR (RFC 7049) mades a suitable test case for libxo's external + * encoder API. It's simple, streaming, well documented, and an + * IETF standard. + * + * This encoder uses the "pretty" flag for diagnostics, which isn't + * really kosher, but it's example code. + */ + +#include <string.h> +#include <sys/types.h> +#include <unistd.h> +#include <stdint.h> +#include <ctype.h> +#include <stdlib.h> +#include <limits.h> + +#include "xo.h" +#include "xo_encoder.h" +#include "xo_buf.h" + +/* + * memdump(): dump memory contents in hex/ascii +0 1 2 3 4 5 6 7 +0123456789012345678901234567890123456789012345678901234567890123456789012345 +XX XX XX XX XX XX XX XX - XX XX XX XX XX XX XX XX abcdefghijklmnop + */ +static void +cbor_memdump (FILE *fp, const char *title, const char *data, + size_t len, const char *tag, int indent) +{ + enum { MAX_PER_LINE = 16 }; + char buf[ 80 ]; + char text[ 80 ]; + char *bp, *tp; + size_t i; +#if 0 + static const int ends[ MAX_PER_LINE ] = { 2, 5, 8, 11, 15, 18, 21, 24, + 29, 32, 35, 38, 42, 45, 48, 51 }; +#endif + + if (fp == NULL) + fp = stdout; + if (tag == NULL) + tag = ""; + + fprintf(fp, "%*s[%s] @ %p (%lx/%lu)\n", indent + 1, tag, + title, data, (unsigned long) len, (unsigned long) len); + + while (len > 0) { + bp = buf; + tp = text; + + for (i = 0; i < MAX_PER_LINE && i < len; i++) { + if (i && (i % 4) == 0) *bp++ = ' '; + if (i == 8) { + *bp++ = '-'; + *bp++ = ' '; + } + sprintf(bp, "%02x ", (unsigned char) *data); + bp += strlen(bp); + *tp++ = (isprint((int) *data) && *data >= ' ') ? *data : '.'; + data += 1; + } + + *tp = 0; + *bp = 0; + fprintf(fp, "%*s%-54s%s\n", indent + 1, tag, buf, text); + len -= i; + } +} + +/* + * CBOR breaks the first byte into two pieces, the major type in the + * top 3 bits and the minor value in the low 5 bits. The value can be + * a small value (0 .. 23), an 8-bit value (24), a 16-bit value (25), + * a 32-bit value (26), or a 64-bit value (27). A value of 31 + * represents an unknown length, which we'll use extensively for + * streaming our content. + */ +#define CBOR_MAJOR_MASK 0xE0 +#define CBOR_MINOR_MASK 0x1F +#define CBOR_MAJOR_SHIFT 5 + +#define CBOR_MAJOR(_x) ((_x) & CBOR_MAJOR_MASK) +#define CBOR_MAJOR_VAL(_x) ((_x) << CBOR_MAJOR_SHIFT) +#define CBOR_MINOR_VAL(_x) ((_x) & CBOR_MINOR_MASK) + +/* Major type codes */ +#define CBOR_UNSIGNED CBOR_MAJOR_VAL(0) /* 0x00 */ +#define CBOR_NEGATIVE CBOR_MAJOR_VAL(1) /* 0x20 */ +#define CBOR_BYTES CBOR_MAJOR_VAL(2) /* 0x40 */ +#define CBOR_STRING CBOR_MAJOR_VAL(3) /* 0x60 */ +#define CBOR_ARRAY CBOR_MAJOR_VAL(4) /* 0x80 */ +#define CBOR_MAP CBOR_MAJOR_VAL(5) /* 0xa0 */ +#define CBOR_SEMANTIC CBOR_MAJOR_VAL(6) /* 0xc0 */ +#define CBOR_SPECIAL CBOR_MAJOR_VAL(7) /* 0xe0 */ + +#define CBOR_ULIMIT 24 /* Largest unsigned value */ +#define CBOR_NLIMIT 23 /* Largest negative value */ + +#define CBOR_BREAK 0xFF +#define CBOR_INDEF 0x1F + +#define CBOR_FALSE 0xF4 +#define CBOR_TRUE 0xF5 +#define CBOR_NULL 0xF6 +#define CBOR_UNDEF 0xF7 + +#define CBOR_LEN8 0x18 /* 24 - 8-bit value */ +#define CBOR_LEN16 0x19 /* 25 - 16-bit value */ +#define CBOR_LEN32 0x1a /* 26 - 32-bit value */ +#define CBOR_LEN64 0x1b /* 27 - 64-bit value */ +#define CBOR_LEN128 0x1c /* 28 - 128-bit value */ + +typedef struct cbor_private_s { + xo_buffer_t c_data; /* Our data buffer */ + unsigned c_indent; /* Indent level */ + unsigned c_open_leaf_list; /* Open leaf list construct? */ +} cbor_private_t; + +static void +cbor_encode_uint (xo_buffer_t *xbp, uint64_t minor, unsigned limit) +{ + char *bp = xbp->xb_curp; + int i, m; + + if (minor > (1ULL << 32)) { + *bp++ |= CBOR_LEN64; + m = 64; + + } else if (minor > (1<<16)) { + *bp++ |= CBOR_LEN32; + m = 32; + + } else if (minor > (1<<8)) { + *bp++ |= CBOR_LEN16; + m = 16; + + } else if (minor > limit) { + *bp++ |= CBOR_LEN8; + m = 8; + } else { + *bp++ |= minor & CBOR_MINOR_MASK; + m = 0; + } + + if (m) { + for (i = m - 8; i >= 0; i -= 8) + *bp++ = minor >> i; + } + + xbp->xb_curp = bp; +} + +static void +cbor_append (xo_handle_t *xop, cbor_private_t *cbor, xo_buffer_t *xbp, + unsigned major, unsigned minor, const char *data) +{ + if (!xo_buf_has_room(xbp, minor + 2)) + return; + + unsigned offset = xo_buf_offset(xbp); + + *xbp->xb_curp = major; + cbor_encode_uint(xbp, minor, CBOR_ULIMIT); + if (data) + xo_buf_append(xbp, data, minor); + + if (xo_get_flags(xop) & XOF_PRETTY) + cbor_memdump(stdout, "append", xo_buf_data(xbp, offset), + xbp->xb_curp - xbp->xb_bufp - offset, "", + cbor->c_indent * 2); +} + +static int +cbor_create (xo_handle_t *xop) +{ + cbor_private_t *cbor = xo_realloc(NULL, sizeof(*cbor)); + if (cbor == NULL) + return -1; + + bzero(cbor, sizeof(*cbor)); + xo_buf_init(&cbor->c_data); + + xo_set_private(xop, cbor); + + cbor_append(xop, cbor, &cbor->c_data, CBOR_MAP | CBOR_INDEF, 0, NULL); + + return 0; +} + +static int +cbor_content (xo_handle_t *xop, cbor_private_t *cbor, xo_buffer_t *xbp, + const char *value) +{ + int rc = 0; + + unsigned offset = xo_buf_offset(xbp); + + if (value == NULL || *value == '\0' || xo_streq(value, "true")) + cbor_append(xop, cbor, &cbor->c_data, CBOR_TRUE, 0, NULL); + else if (xo_streq(value, "false")) + cbor_append(xop, cbor, &cbor->c_data, CBOR_FALSE, 0, NULL); + else { + int negative = 0; + if (*value == '-') { + value += 1; + negative = 1; + } + + char *ep; + unsigned long long ival; + ival = strtoull(value, &ep, 0); + if (ival == ULLONG_MAX) /* Sometimes a string is just a string */ + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(value), value); + else { + *xbp->xb_curp = negative ? CBOR_NEGATIVE : CBOR_UNSIGNED; + if (negative) + ival -= 1; /* Don't waste a negative zero */ + cbor_encode_uint(xbp, ival, negative ? CBOR_NLIMIT : CBOR_ULIMIT); + } + } + + if (xo_get_flags(xop) & XOF_PRETTY) + cbor_memdump(stdout, "content", xo_buf_data(xbp, offset), + xbp->xb_curp - xbp->xb_bufp - offset, "", + cbor->c_indent * 2); + + return rc; +} + +static int +cbor_handler (XO_ENCODER_HANDLER_ARGS) +{ + int rc = 0; + cbor_private_t *cbor = private; + xo_buffer_t *xbp = cbor ? &cbor->c_data : NULL; + + if (xo_get_flags(xop) & XOF_PRETTY) { + printf("%*sop %s: [%s] [%s]\n", cbor ? cbor->c_indent * 2 + 4 : 0, "", + xo_encoder_op_name(op), name, value); + fflush(stdout); + } + + /* If we don't have private data, we're sunk */ + if (cbor == NULL && op != XO_OP_CREATE) + return -1; + + switch (op) { + case XO_OP_CREATE: /* Called when the handle is init'd */ + rc = cbor_create(xop); + break; + + case XO_OP_OPEN_CONTAINER: + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(name), name); + cbor_append(xop, cbor, xbp, CBOR_MAP | CBOR_INDEF, 0, NULL); + cbor->c_indent += 1; + break; + + case XO_OP_CLOSE_CONTAINER: + cbor_append(xop, cbor, xbp, CBOR_BREAK, 0, NULL); + cbor->c_indent -= 1; + break; + + case XO_OP_OPEN_LIST: + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(name), name); + cbor_append(xop, cbor, xbp, CBOR_ARRAY | CBOR_INDEF, 0, NULL); + cbor->c_indent += 1; + break; + + case XO_OP_CLOSE_LIST: + cbor_append(xop, cbor, xbp, CBOR_BREAK, 0, NULL); + cbor->c_indent -= 1; + break; + + case XO_OP_OPEN_LEAF_LIST: + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(name), name); + cbor_append(xop, cbor, xbp, CBOR_ARRAY | CBOR_INDEF, 0, NULL); + cbor->c_indent += 1; + cbor->c_open_leaf_list = 1; + break; + + case XO_OP_CLOSE_LEAF_LIST: + cbor_append(xop, cbor, xbp, CBOR_BREAK, 0, NULL); + cbor->c_indent -= 1; + cbor->c_open_leaf_list = 0; + break; + + case XO_OP_OPEN_INSTANCE: + cbor_append(xop, cbor, xbp, CBOR_MAP | CBOR_INDEF, 0, NULL); + cbor->c_indent += 1; + break; + + case XO_OP_CLOSE_INSTANCE: + cbor_append(xop, cbor, xbp, CBOR_BREAK, 0, NULL); + cbor->c_indent -= 1; + break; + + case XO_OP_STRING: /* Quoted UTF-8 string */ + if (!cbor->c_open_leaf_list) + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(name), name); + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(value), value); + break; + + case XO_OP_CONTENT: /* Other content */ + if (!cbor->c_open_leaf_list) + cbor_append(xop, cbor, xbp, CBOR_STRING, strlen(name), name); + + /* + * It's content, not string, so we need to look at the + * string and build some content. Turns out we only + * care about true, false, null, and numbers. + */ + cbor_content(xop, cbor, xbp, value); + break; + + case XO_OP_FINISH: /* Clean up function */ + cbor_append(xop, cbor, xbp, CBOR_BREAK, 0, NULL); + cbor->c_indent -= 1; + break; + + case XO_OP_FLUSH: /* Clean up function */ + if (xo_get_flags(xop) & XOF_PRETTY) + cbor_memdump(stdout, "cbor", + xbp->xb_bufp, xbp->xb_curp - xbp->xb_bufp, + ">", 0); + else { + rc = write(1, xbp->xb_bufp, xbp->xb_curp - xbp->xb_bufp); + if (rc > 0) + rc = 0; + } + break; + + case XO_OP_DESTROY: /* Clean up function */ + break; + + case XO_OP_ATTRIBUTE: /* Attribute name/value */ + break; + + case XO_OP_VERSION: /* Version string */ + break; + + } + + return rc; +} + +int +xo_encoder_library_init (XO_ENCODER_INIT_ARGS) +{ + arg->xei_handler = cbor_handler; + arg->xei_version = XO_ENCODER_VERSION; + + return 0; +} diff --git a/contrib/libxo/encoder/csv/Makefile.am b/contrib/libxo/encoder/csv/Makefile.am new file mode 100644 index 000000000000..17faf718267a --- /dev/null +++ b/contrib/libxo/encoder/csv/Makefile.am @@ -0,0 +1,51 @@ +# +# $Id$ +# +# Copyright 2015-2019, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +if LIBXO_WARNINGS_HIGH +LIBXO_WARNINGS = HIGH +endif +if HAVE_GCC +GCC_WARNINGS = yes +endif +include ${top_srcdir}/warnings.mk + +enc_csvincdir = ${includedir}/libxo + +AM_CFLAGS = \ + -I${top_srcdir}/libxo \ + -I${top_builddir}/libxo \ + ${WARNINGS} + +LIBNAME = libenc_csv +pkglib_LTLIBRARIES = libenc_csv.la +LIBS = \ + -L${top_builddir}/libxo -lxo + +LDADD = ${top_builddir}/libxo/libxo.la + +libenc_csv_la_SOURCES = \ + enc_csv.c + +pkglibdir = ${XO_ENCODERDIR} + +UGLY_NAME = csv.enc + +install-exec-hook: + @DLNAME=`sh -c '. ./libenc_csv.la ; echo $$dlname'` ; \ + if [ x"$$DLNAME" = x ]; \ + then DLNAME=${LIBNAME}.${XO_LIBEXT}; fi ; \ + if [ "$(build_os)" = "cygwin" ]; \ + then DLNAME="../bin/$$DLNAME"; fi ; \ + echo Install link $$DLNAME "->" ${UGLY_NAME} "..." ; \ + mkdir -p ${DESTDIR}${XO_ENCODERDIR} ; \ + cd ${DESTDIR}${XO_ENCODERDIR} \ + && chmod +w . \ + && rm -f ${UGLY_NAME} \ + && ${LN_S} $$DLNAME ${UGLY_NAME} diff --git a/contrib/libxo/encoder/csv/enc_csv.c b/contrib/libxo/encoder/csv/enc_csv.c new file mode 100644 index 000000000000..10f9110f4939 --- /dev/null +++ b/contrib/libxo/encoder/csv/enc_csv.c @@ -0,0 +1,834 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, August 2015 + */ + +/* + * CSV encoder generates comma-separated value files for specific + * subsets of data. This is not (and cannot be) a generalized + * facility, but for specific subsets of data, CSV data can be + * reasonably generated. For example, the df XML content: + * <filesystem> + * <name>procfs</name> + * <total-blocks>4</total-blocks> + * <used-blocks>4</used-blocks> + * <available-blocks>0</available-blocks> + * <used-percent>100</used-percent> + * <mounted-on>/proc</mounted-on> + * </filesystem> + * + * could be represented as: + * + * #+name,total-blocks,used-blocks,available-blocks,used-percent,mounted-on + * procfs,4,4,0,100,/proc + * + * Data is then constrained to be sibling leaf values. In addition, + * singular leafs can also be matched. The costs include recording + * the specific leaf names (to ensure consistency) and some + * buffering. + * + * Some escaping is needed for CSV files, following the rules of RFC4180: + * + * - Fields containing a line-break, double-quote or commas should be + * quoted. (If they are not, the file will likely be impossible to + * process correctly). + * - A (double) quote character in a field must be represented by two + * (double) quote characters. + * - Leading and trialing whitespace require fields be quoted. + * + * Cheesy, but simple. The RFC also requires MS-DOS end-of-line, + * which we only do with the "dos" option. Strange that we still live + * in a DOS-friendly world, but then again, we make spaceships based + * on the horse butts (http://www.astrodigital.org/space/stshorse.html + * though the "built by English expatriates” bit is rubbish; better to + * say the first engines used in America were built by Englishmen.) + */ + +#include <string.h> +#include <sys/types.h> +#include <unistd.h> +#include <stdint.h> +#include <ctype.h> +#include <stdlib.h> +#include <limits.h> + +#include "xo.h" +#include "xo_encoder.h" +#include "xo_buf.h" + +#ifndef UNUSED +#define UNUSED __attribute__ ((__unused__)) +#endif /* UNUSED */ + +/* + * The CSV encoder has three moving parts: + * + * - The path holds the path we are matching against + * - This is given as input via "options" and does not change + * + * - The stack holds the current names of the open elements + * - The "open" operations push, while the "close" pop + * - Turns out, at this point, the stack is unused, but I've + * left "drippings" in the code because I see this as useful + * for future features (under CSV_STACK_IS_NEEDED). + * + * - The leafs record the current set of leaf + * - A key from the parent list counts as a leaf (unless CF_NO_KEYS) + * - Once the path is matched, all other leafs at that level are leafs + * - Leafs are recorded to get the header comment accurately recorded + * - Once the first line is emited, the set of leafs _cannot_ change + * + * We use offsets into the buffers, since we know they can be + * realloc'd out from under us, as the size increases. The 'path' + * is fixed, we allocate it once, so it doesn't need offsets. + */ +typedef struct path_frame_s { + char *pf_name; /* Path member name; points into c_path_buf */ + uint32_t pf_flags; /* Flags for this path element (PFF_*) */ +} path_frame_t; + +typedef struct stack_frame_s { + ssize_t sf_off; /* Element name; offset in c_stack_buf */ + uint32_t sf_flags; /* Flags for this frame (SFF_*) */ +} stack_frame_t; + +/* Flags for sf_flags */ + +typedef struct leaf_s { + ssize_t f_name; /* Name of leaf; offset in c_name_buf */ + ssize_t f_value; /* Value of leaf; offset in c_value_buf */ + uint32_t f_flags; /* Flags for this value (FF_*) */ +#ifdef CSV_STACK_IS_NEEDED + ssize_t f_depth; /* Depth of stack when leaf was recorded */ +#endif /* CSV_STACK_IS_NEEDED */ +} leaf_t; + +/* Flags for f_flags */ +#define LF_KEY (1<<0) /* Leaf is a key */ +#define LF_HAS_VALUE (1<<1) /* Value has been set */ + +typedef struct csv_private_s { + uint32_t c_flags; /* Flags for this encoder */ + + /* The path for which we select leafs */ + char *c_path_buf; /* Buffer containing path members */ + path_frame_t *c_path; /* Array of path members */ + ssize_t c_path_max; /* Depth of c_path[] */ + ssize_t c_path_cur; /* Current depth in c_path[] */ + + /* A stack of open elements (xo_op_list, xo_op_container) */ +#if CSV_STACK_IS_NEEDED + xo_buffer_t c_stack_buf; /* Buffer used for stack content */ + stack_frame_t *c_stack; /* Stack of open tags */ + ssize_t c_stack_max; /* Maximum stack depth */ +#endif /* CSV_STACK_IS_NEEDED */ + ssize_t c_stack_depth; /* Current stack depth */ + + /* List of leafs we are emitting (to ensure consistency) */ + xo_buffer_t c_name_buf; /* String buffer for leaf names */ + xo_buffer_t c_value_buf; /* String buffer for leaf values */ + leaf_t *c_leaf; /* List of leafs */ + ssize_t c_leaf_depth; /* Current depth of c_leaf[] (next free) */ + ssize_t c_leaf_max; /* Max depth of c_leaf[] */ + + xo_buffer_t c_data; /* Buffer for creating data */ +} csv_private_t; + +#define C_STACK_MAX 32 /* default c_stack_max */ +#define C_LEAF_MAX 32 /* default c_leaf_max */ + +/* Flags for this structure */ +#define CF_HEADER_DONE (1<<0) /* Have already written the header */ +#define CF_NO_HEADER (1<<1) /* Do not generate header */ +#define CF_NO_KEYS (1<<2) /* Do not generate excess keys */ +#define CF_VALUE_ONLY (1<<3) /* Only generate the value */ + +#define CF_DOS_NEWLINE (1<<4) /* Generate CR-NL, just like MS-DOS */ +#define CF_LEAFS_DONE (1<<5) /* Leafs are already been recorded */ +#define CF_NO_QUOTES (1<<6) /* Do not generate quotes */ +#define CF_RECORD_DATA (1<<7) /* Record all sibling leafs */ + +#define CF_DEBUG (1<<8) /* Make debug output */ +#define CF_HAS_PATH (1<<9) /* A "path" option was provided */ + +/* + * A simple debugging print function, similar to psu_dbg. Controlled by + * the undocumented "debug" option. + */ +static void +csv_dbg (xo_handle_t *xop UNUSED, csv_private_t *csv UNUSED, + const char *fmt, ...) +{ + if (csv == NULL || !(csv->c_flags & CF_DEBUG)) + return; + + va_list vap; + + va_start(vap, fmt); + vfprintf(stderr, fmt, vap); + va_end(vap); +} + +/* + * Create the private data for this handle, initialize it, and record + * the pointer in the handle. + */ +static int +csv_create (xo_handle_t *xop) +{ + csv_private_t *csv = xo_realloc(NULL, sizeof(*csv)); + if (csv == NULL) + return -1; + + bzero(csv, sizeof(*csv)); + xo_buf_init(&csv->c_data); + xo_buf_init(&csv->c_name_buf); + xo_buf_init(&csv->c_value_buf); +#ifdef CSV_STACK_IS_NEEDED + xo_buf_init(&csv->c_stack_buf); +#endif /* CSV_STACK_IS_NEEDED */ + + xo_set_private(xop, csv); + + return 0; +} + +/* + * Clean up and release any data in use by this handle + */ +static void +csv_destroy (xo_handle_t *xop UNUSED, csv_private_t *csv) +{ + /* Clean up */ + xo_buf_cleanup(&csv->c_data); + xo_buf_cleanup(&csv->c_name_buf); + xo_buf_cleanup(&csv->c_value_buf); +#ifdef CSV_STACK_IS_NEEDED + xo_buf_cleanup(&csv->c_stack_buf); +#endif /* CSV_STACK_IS_NEEDED */ + + if (csv->c_leaf) + xo_free(csv->c_leaf); + if (csv->c_path_buf) + xo_free(csv->c_path_buf); +} + +/* + * Return the element name at the top of the path stack. This is the + * item that we are currently trying to match on. + */ +static const char * +csv_path_top (csv_private_t *csv, ssize_t delta) +{ + if (!(csv->c_flags & CF_HAS_PATH) || csv->c_path == NULL) + return NULL; + + ssize_t cur = csv->c_path_cur + delta; + + if (cur < 0) + return NULL; + + return csv->c_path[cur].pf_name; +} + +/* + * Underimplemented stack functionality + */ +static inline void +csv_stack_push (csv_private_t *csv UNUSED, const char *name UNUSED) +{ +#ifdef CSV_STACK_IS_NEEDED + csv->c_stack_depth += 1; +#endif /* CSV_STACK_IS_NEEDED */ +} + +/* + * Underimplemented stack functionality + */ +static inline void +csv_stack_pop (csv_private_t *csv UNUSED, const char *name UNUSED) +{ +#ifdef CSV_STACK_IS_NEEDED + csv->c_stack_depth -= 1; +#endif /* CSV_STACK_IS_NEEDED */ +} + +/* Flags for csv_quote_flags */ +#define QF_NEEDS_QUOTES (1<<0) /* Needs to be quoted */ +#define QF_NEEDS_ESCAPE (1<<1) /* Needs to be escaped */ + +/* + * Determine how much quote processing is needed. The details of the + * quoting rules are given at the top of this file. We return a set + * of flags, indicating what's needed. + */ +static uint32_t +csv_quote_flags (xo_handle_t *xop UNUSED, csv_private_t *csv UNUSED, + const char *value) +{ + static const char quoted[] = "\n\r\","; + static const char escaped[] = "\""; + + if (csv->c_flags & CF_NO_QUOTES) /* User doesn't want quotes */ + return 0; + + size_t len = strlen(value); + uint32_t rc = 0; + + if (strcspn(value, quoted) != len) + rc |= QF_NEEDS_QUOTES; + else if (isspace((int) value[0])) /* Leading whitespace */ + rc |= QF_NEEDS_QUOTES; + else if (isspace((int) value[len - 1])) /* Trailing whitespace */ + rc |= QF_NEEDS_QUOTES; + + if (strcspn(value, escaped) != len) + rc |= QF_NEEDS_ESCAPE; + + csv_dbg(xop, csv, "csv: quote flags [%s] -> %x (%zu/%zu)\n", + value, rc, len, strcspn(value, quoted)); + + return rc; +} + +/* + * Escape the string, following the rules in RFC4180 + */ +static void +csv_escape (xo_buffer_t *xbp, const char *value, size_t len) +{ + const char *cp, *ep, *np; + + for (cp = value, ep = value + len; cp && cp < ep; cp = np) { + np = strchr(cp, '"'); + if (np) { + np += 1; + xo_buf_append(xbp, cp, np - cp); + xo_buf_append(xbp, "\"", 1); + } else + xo_buf_append(xbp, cp, ep - cp); + } +} + +/* + * Append a newline to the buffer, following the settings of the "dos" + * flag. + */ +static void +csv_append_newline (xo_buffer_t *xbp, csv_private_t *csv) +{ + if (csv->c_flags & CF_DOS_NEWLINE) + xo_buf_append(xbp, "\r\n", 2); + else + xo_buf_append(xbp, "\n", 1); +} + +/* + * Create a 'record' of 'fields' from our recorded leaf values. If + * this is the first line and "no-header" isn't given, make a record + * containing the leaf names. + */ +static void +csv_emit_record (xo_handle_t *xop, csv_private_t *csv) +{ + csv_dbg(xop, csv, "csv: emit: ...\n"); + + ssize_t fnum; + uint32_t quote_flags; + leaf_t *lp; + + /* If we have no data, then don't bother */ + if (csv->c_leaf_depth == 0) + return; + + if (!(csv->c_flags & (CF_HEADER_DONE | CF_NO_HEADER))) { + csv->c_flags |= CF_HEADER_DONE; + + for (fnum = 0; fnum < csv->c_leaf_depth; fnum++) { + lp = &csv->c_leaf[fnum]; + const char *name = xo_buf_data(&csv->c_name_buf, lp->f_name); + + if (fnum != 0) + xo_buf_append(&csv->c_data, ",", 1); + + xo_buf_append(&csv->c_data, name, strlen(name)); + } + + csv_append_newline(&csv->c_data, csv); + } + + for (fnum = 0; fnum < csv->c_leaf_depth; fnum++) { + lp = &csv->c_leaf[fnum]; + const char *value; + + if (lp->f_flags & LF_HAS_VALUE) { + value = xo_buf_data(&csv->c_value_buf, lp->f_value); + } else { + value = ""; + } + + quote_flags = csv_quote_flags(xop, csv, value); + + if (fnum != 0) + xo_buf_append(&csv->c_data, ",", 1); + + if (quote_flags & QF_NEEDS_QUOTES) + xo_buf_append(&csv->c_data, "\"", 1); + + if (quote_flags & QF_NEEDS_ESCAPE) + csv_escape(&csv->c_data, value, strlen(value)); + else + xo_buf_append(&csv->c_data, value, strlen(value)); + + if (quote_flags & QF_NEEDS_QUOTES) + xo_buf_append(&csv->c_data, "\"", 1); + } + + csv_append_newline(&csv->c_data, csv); + + /* We flush if either flush flag is set */ + if (xo_get_flags(xop) & (XOF_FLUSH | XOF_FLUSH_LINE)) + xo_flush_h(xop); + + /* Clean out values from leafs */ + for (fnum = 0; fnum < csv->c_leaf_depth; fnum++) { + lp = &csv->c_leaf[fnum]; + + lp->f_flags &= ~LF_HAS_VALUE; + lp->f_value = 0; + } + + xo_buf_reset(&csv->c_value_buf); + + /* + * Once we emit the first line, our set of leafs is locked and + * cannot be changed. + */ + csv->c_flags |= CF_LEAFS_DONE; +} + +/* + * Open a "level" of hierarchy, either a container or an instance. Look + * for a match in the path=x/y/z hierarchy, and ignore if not a match. + * If we're at the end of the path, start recording leaf values. + */ +static int +csv_open_level (xo_handle_t *xop UNUSED, csv_private_t *csv, + const char *name, int instance) +{ + /* An new "open" event means we stop recording */ + if (csv->c_flags & CF_RECORD_DATA) { + csv->c_flags &= ~CF_RECORD_DATA; + csv_emit_record(xop, csv); + return 0; + } + + const char *path_top = csv_path_top(csv, 0); + + /* If the top of the stack does not match the name, then ignore */ + if (path_top == NULL) { + if (instance && !(csv->c_flags & CF_HAS_PATH)) { + csv_dbg(xop, csv, "csv: recording (no-path) ...\n"); + csv->c_flags |= CF_RECORD_DATA; + } + + } else if (xo_streq(path_top, name)) { + csv->c_path_cur += 1; /* Advance to next path member */ + + csv_dbg(xop, csv, "csv: match: [%s] (%zd/%zd)\n", name, + csv->c_path_cur, csv->c_path_max); + + /* If we're all the way thru the path members, start recording */ + if (csv->c_path_cur == csv->c_path_max) { + csv_dbg(xop, csv, "csv: recording ...\n"); + csv->c_flags |= CF_RECORD_DATA; + } + } + + /* Push the name on the stack */ + csv_stack_push(csv, name); + + return 0; +} + +/* + * Close a "level", either a container or an instance. + */ +static int +csv_close_level (xo_handle_t *xop UNUSED, csv_private_t *csv, const char *name) +{ + /* If we're recording, a close triggers an emit */ + if (csv->c_flags & CF_RECORD_DATA) { + csv->c_flags &= ~CF_RECORD_DATA; + csv_emit_record(xop, csv); + } + + const char *path_top = csv_path_top(csv, -1); + csv_dbg(xop, csv, "csv: close: [%s] [%s] (%zd)\n", name, + path_top ?: "", csv->c_path_cur); + + /* If the top of the stack does not match the name, then ignore */ + if (path_top != NULL && xo_streq(path_top, name)) { + csv->c_path_cur -= 1; + return 0; + } + + /* Pop the name off the stack */ + csv_stack_pop(csv, name); + + return 0; +} + +/* + * Return the index of a given leaf in the c_leaf[] array, where we + * record leaf values. If the leaf is new and we haven't stopped recording + * leafs, then make a new slot for it and record the name. + */ +static int +csv_leaf_num (xo_handle_t *xop UNUSED, csv_private_t *csv, + const char *name, xo_xff_flags_t flags) +{ + ssize_t fnum; + leaf_t *lp; + xo_buffer_t *xbp = &csv->c_name_buf; + + for (fnum = 0; fnum < csv->c_leaf_depth; fnum++) { + lp = &csv->c_leaf[fnum]; + + const char *fname = xo_buf_data(xbp, lp->f_name); + if (xo_streq(fname, name)) + return fnum; + } + + /* If we're done with adding new leafs, then bail */ + if (csv->c_flags & CF_LEAFS_DONE) + return -1; + + /* This leaf does not exist yet, so we need to create it */ + /* Start by checking if there's enough room */ + if (csv->c_leaf_depth + 1 >= csv->c_leaf_max) { + /* Out of room; realloc it */ + ssize_t new_max = csv->c_leaf_max * 2; + if (new_max == 0) + new_max = C_LEAF_MAX; + + lp = xo_realloc(csv->c_leaf, new_max * sizeof(*lp)); + if (lp == NULL) + return -1; /* No luck; bail */ + + /* Zero out the new portion */ + bzero(&lp[csv->c_leaf_max], csv->c_leaf_max * sizeof(*lp)); + + /* Update csv data */ + csv->c_leaf = lp; + csv->c_leaf_max = new_max; + } + + lp = &csv->c_leaf[csv->c_leaf_depth++]; +#ifdef CSV_STACK_IS_NEEDED + lp->f_depth = csv->c_stack_depth; +#endif /* CSV_STACK_IS_NEEDED */ + + lp->f_name = xo_buf_offset(xbp); + + char *cp = xo_buf_cur(xbp); + xo_buf_append(xbp, name, strlen(name) + 1); + + if (flags & XFF_KEY) + lp->f_flags |= LF_KEY; + + csv_dbg(xop, csv, "csv: leaf: name: %zd [%s] [%s] %x\n", + fnum, name, cp, lp->f_flags); + + return fnum; +} + +/* + * Record a new value for a leaf + */ +static void +csv_leaf_set (xo_handle_t *xop UNUSED, csv_private_t *csv, leaf_t *lp, + const char *value) +{ + xo_buffer_t *xbp = &csv->c_value_buf; + + lp->f_value = xo_buf_offset(xbp); + lp->f_flags |= LF_HAS_VALUE; + + char *cp = xo_buf_cur(xbp); + xo_buf_append(xbp, value, strlen(value) + 1); + + csv_dbg(xop, csv, "csv: leaf: value: [%s] [%s] %x\n", + value, cp, lp->f_flags); +} + +/* + * Record the requested set of leaf names. The input should be a set + * of leaf names, separated by periods. + */ +static int +csv_record_leafs (xo_handle_t *xop, csv_private_t *csv, const char *leafs_raw) +{ + char *cp, *ep, *np; + ssize_t len = strlen(leafs_raw); + char *leafs_buf = alloca(len + 1); + + memcpy(leafs_buf, leafs_raw, len + 1); /* Make local copy */ + + for (cp = leafs_buf, ep = leafs_buf + len; cp && cp < ep; cp = np) { + np = strchr(cp, '.'); + if (np) + *np++ = '\0'; + + if (*cp == '\0') /* Skip empty names */ + continue; + + csv_dbg(xop, csv, "adding leaf: [%s]\n", cp); + csv_leaf_num(xop, csv, cp, 0); + } + + /* + * Since we've been told explicitly what leafs matter, ignore the rest + */ + csv->c_flags |= CF_LEAFS_DONE; + + return 0; +} + +/* + * Record the requested path elements. The input should be a set of + * container or instances names, separated by slashes. + */ +static int +csv_record_path (xo_handle_t *xop, csv_private_t *csv, const char *path_raw) +{ + int count; + char *cp, *ep, *np; + ssize_t len = strlen(path_raw); + char *path_buf = xo_realloc(NULL, len + 1); + + memcpy(path_buf, path_raw, len + 1); + + for (cp = path_buf, ep = path_buf + len, count = 2; + cp && cp < ep; cp = np) { + np = strchr(cp, '/'); + if (np) { + np += 1; + count += 1; + } + } + + path_frame_t *path = xo_realloc(NULL, sizeof(path[0]) * count); + if (path == NULL) { + xo_failure(xop, "allocation failure for path '%s'", path_buf); + return -1; + } + + bzero(path, sizeof(path[0]) * count); + + for (count = 0, cp = path_buf; cp && cp < ep; cp = np) { + path[count++].pf_name = cp; + + np = strchr(cp, '/'); + if (np) + *np++ = '\0'; + csv_dbg(xop, csv, "path: [%s]\n", cp); + } + + path[count].pf_name = NULL; + + if (csv->c_path) /* In case two paths are given */ + xo_free(csv->c_path); + if (csv->c_path_buf) /* In case two paths are given */ + xo_free(csv->c_path_buf); + + csv->c_path_buf = path_buf; + csv->c_path = path; + csv->c_path_max = count; + csv->c_path_cur = 0; + + return 0; +} + +/* + * Extract the option values. The format is: + * -libxo encoder=csv:kw=val:kw=val:kw=val,pretty + * -libxo encoder=csv+kw=val+kw=val+kw=val,pretty + */ +static int +csv_options (xo_handle_t *xop, csv_private_t *csv, + const char *raw_opts, char opts_char) +{ + ssize_t len = strlen(raw_opts); + char *options = alloca(len + 1); + memcpy(options, raw_opts, len); + options[len] = '\0'; + + char *cp, *ep, *np, *vp; + for (cp = options, ep = options + len + 1; cp && cp < ep; cp = np) { + np = strchr(cp, opts_char); + if (np) + *np++ = '\0'; + + vp = strchr(cp, '='); + if (vp) + *vp++ = '\0'; + + if (xo_streq(cp, "path")) { + /* Record the path */ + if (vp != NULL && csv_record_path(xop, csv, vp)) + return -1; + + csv->c_flags |= CF_HAS_PATH; /* Yup, we have an explicit path now */ + + } else if (xo_streq(cp, "leafs") + || xo_streq(cp, "leaf") + || xo_streq(cp, "leaves")) { + /* Record the leafs */ + if (vp != NULL && csv_record_leafs(xop, csv, vp)) + return -1; + + } else if (xo_streq(cp, "no-keys")) { + csv->c_flags |= CF_NO_KEYS; + } else if (xo_streq(cp, "no-header")) { + csv->c_flags |= CF_NO_HEADER; + } else if (xo_streq(cp, "value-only")) { + csv->c_flags |= CF_VALUE_ONLY; + } else if (xo_streq(cp, "dos")) { + csv->c_flags |= CF_DOS_NEWLINE; + } else if (xo_streq(cp, "no-quotes")) { + csv->c_flags |= CF_NO_QUOTES; + } else if (xo_streq(cp, "debug")) { + csv->c_flags |= CF_DEBUG; + } else { + xo_warn_hc(xop, -1, + "unknown encoder option value: '%s'", cp); + return -1; + } + } + + return 0; +} + +/* + * Handler for incoming data values. We just record each leaf name and + * value. The values are emittd when the instance is closed. + */ +static int +csv_data (xo_handle_t *xop UNUSED, csv_private_t *csv UNUSED, + const char *name, const char *value, + xo_xof_flags_t flags) +{ + csv_dbg(xop, csv, "data: [%s]=[%s] %llx\n", name, value, (unsigned long long) flags); + + if (!(csv->c_flags & CF_RECORD_DATA)) + return 0; + + /* Find the leaf number */ + int fnum = csv_leaf_num(xop, csv, name, flags); + if (fnum < 0) + return 0; /* Don't bother recording */ + + leaf_t *lp = &csv->c_leaf[fnum]; + csv_leaf_set(xop, csv, lp, value); + + return 0; +} + +/* + * The callback from libxo, passing us operations/events as they + * happen. + */ +static int +csv_handler (XO_ENCODER_HANDLER_ARGS) +{ + int rc = 0; + csv_private_t *csv = private; + xo_buffer_t *xbp = csv ? &csv->c_data : NULL; + + csv_dbg(xop, csv, "op %s: [%s] [%s]\n", xo_encoder_op_name(op), + name ?: "", value ?: ""); + fflush(stdout); + + /* If we don't have private data, we're sunk */ + if (csv == NULL && op != XO_OP_CREATE) + return -1; + + switch (op) { + case XO_OP_CREATE: /* Called when the handle is init'd */ + rc = csv_create(xop); + break; + + case XO_OP_OPTIONS: + rc = csv_options(xop, csv, value, ':'); + break; + + case XO_OP_OPTIONS_PLUS: + rc = csv_options(xop, csv, value, '+'); + break; + + case XO_OP_OPEN_LIST: + case XO_OP_CLOSE_LIST: + break; /* Ignore these ops */ + + case XO_OP_OPEN_CONTAINER: + case XO_OP_OPEN_LEAF_LIST: + rc = csv_open_level(xop, csv, name, 0); + break; + + case XO_OP_OPEN_INSTANCE: + rc = csv_open_level(xop, csv, name, 1); + break; + + case XO_OP_CLOSE_CONTAINER: + case XO_OP_CLOSE_LEAF_LIST: + case XO_OP_CLOSE_INSTANCE: + rc = csv_close_level(xop, csv, name); + break; + + case XO_OP_STRING: /* Quoted UTF-8 string */ + case XO_OP_CONTENT: /* Other content */ + rc = csv_data(xop, csv, name, value, flags); + break; + + case XO_OP_FINISH: /* Clean up function */ + break; + + case XO_OP_FLUSH: /* Clean up function */ + rc = write(1, xbp->xb_bufp, xbp->xb_curp - xbp->xb_bufp); + if (rc > 0) + rc = 0; + + xo_buf_reset(xbp); + break; + + case XO_OP_DESTROY: /* Clean up function */ + csv_destroy(xop, csv); + break; + + case XO_OP_ATTRIBUTE: /* Attribute name/value */ + break; + + case XO_OP_VERSION: /* Version string */ + break; + } + + return rc; +} + +/* + * Callback when our encoder is loaded. + */ +int +xo_encoder_library_init (XO_ENCODER_INIT_ARGS) +{ + arg->xei_handler = csv_handler; + arg->xei_version = XO_ENCODER_VERSION; + + return 0; +} diff --git a/contrib/libxo/encoder/test/Makefile.am b/contrib/libxo/encoder/test/Makefile.am new file mode 100644 index 000000000000..1d8518e8e7ea --- /dev/null +++ b/contrib/libxo/encoder/test/Makefile.am @@ -0,0 +1,51 @@ +# +# $Id$ +# +# Copyright 2015, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +if LIBXO_WARNINGS_HIGH +LIBXO_WARNINGS = HIGH +endif +if HAVE_GCC +GCC_WARNINGS = yes +endif +include ${top_srcdir}/warnings.mk + +enc_testincdir = ${includedir}/libxo + +AM_CFLAGS = \ + -I${top_srcdir}/libxo \ + -I${top_builddir}/libxo \ + ${WARNINGS} + +LIBNAME = libenc_test +pkglib_LTLIBRARIES = libenc_test.la +LIBS = \ + -L${top_builddir}/libxo -lxo + +LDADD = ${top_builddir}/libxo/libxo.la + +libenc_test_la_SOURCES = \ + enc_test.c + +pkglibdir = ${XO_ENCODERDIR} + +UGLY_NAME = test.enc + +install-exec-hook: + @DLNAME=`sh -c '. ./libenc_test.la ; echo $$dlname'` ; \ + if [ x"$$DLNAME" = x ]; \ + then DLNAME=${LIBNAME}.${XO_LIBEXT}; fi ; \ + if [ "$(build_os)" = "cygwin" ]; \ + then DLNAME="../bin/$$DLNAME"; fi ; \ + echo Install link $$DLNAME "->" ${UGLY_NAME} "..." ; \ + mkdir -p ${DESTDIR}${XO_ENCODERDIR} ; \ + cd ${DESTDIR}${XO_ENCODERDIR} \ + && chmod +w . \ + && rm -f ${UGLY_NAME} \ + && ${LN_S} $$DLNAME ${UGLY_NAME} diff --git a/contrib/libxo/encoder/test/enc_test.c b/contrib/libxo/encoder/test/enc_test.c new file mode 100644 index 000000000000..7107ba733ae9 --- /dev/null +++ b/contrib/libxo/encoder/test/enc_test.c @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, August 2015 + */ + +#include "xo.h" +#include "xo_encoder.h" + +static int +test_handler (XO_ENCODER_HANDLER_ARGS) +{ + printf("op %s: [%s] [%s] [%#llx]\n", xo_encoder_op_name(op), + name ?: "", value ?: "", (unsigned long long) flags); + + return 0; +} + +int +xo_encoder_library_init (XO_ENCODER_INIT_ARGS) +{ + arg->xei_version = XO_ENCODER_VERSION; + arg->xei_handler = test_handler; + + return 0; +} diff --git a/contrib/libxo/libxo-config.in b/contrib/libxo/libxo-config.in new file mode 100644 index 000000000000..f08f2340ecdb --- /dev/null +++ b/contrib/libxo/libxo-config.in @@ -0,0 +1,119 @@ +#! /bin/sh +# +# $Id$ +# +# Copyright 2011-2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +prefix=@prefix@ +exec_prefix=@exec_prefix@ +includedir=@includedir@ +libdir=@libdir@ + +usage() +{ + cat <<EOF +Usage: libxo-config [OPTION] + +Known values for OPTION are: + + --prefix=DIR change libxo prefix [default $prefix] + --exec-prefix=DIR change libxo exec prefix [default $exec_prefix] + --libs print library linking information + --bindir print the bin directory + --cflags print pre-processor and compiler flags + --share print share directory + --help display this help and exit + --version output version information +EOF + + exit $1 +} + +if test $# -eq 0; then + usage 1 +fi + +cflags=false +libs=false + +while test $# -gt 0; do + case "$1" in + -*=*) optarg=`echo "$1" | sed 's/[-_a-zA-Z0-9]*=//'` ;; + *) optarg= ;; + esac + + case "$1" in + --prefix=*) + prefix=$optarg + includedir=$prefix/include + libdir=$prefix/lib + ;; + + --prefix) + echo $prefix + ;; + + --exec-prefix=*) + exec_prefix=$optarg + libdir=$exec_prefix/lib + ;; + + --exec-prefix) + echo $exec_prefix + ;; + + --version) + echo @VERSION@ + exit 0 + ;; + + --help) + usage 0 + ;; + + --cflags) + echo -I@XO_INCLUDEDIR@ @XO_CFLAGS@ + ;; + + + --share) + echo @XO_SHAREDIR@ + ;; + + --bindir) + echo @XO_BINDIR@ + ;; + + --libdir) + echo @XO_LIBDIR@ + ;; + + + --libs) + if [ "`uname`" = "Linux" ] + then + if [ "@XO_LIBDIR@" = "-L/usr/lib" -o "@XO_LIBDIR@" = "-L/usr/lib64" ] + then + echo @XO_LIBS@ + else + echo -L@XO_LIBDIR@ @XO_LIBS@ + fi + else + echo -L@XO_LIBDIR@ @XO_LIBS@ + fi + ;; + + *) + usage + exit 1 + ;; + esac + shift +done + +exit 0 diff --git a/contrib/libxo/libxo/Makefile.am b/contrib/libxo/libxo/Makefile.am new file mode 100644 index 000000000000..9f17527e68ec --- /dev/null +++ b/contrib/libxo/libxo/Makefile.am @@ -0,0 +1,96 @@ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +if LIBXO_WARNINGS_HIGH +LIBXO_WARNINGS = HIGH +endif +if HAVE_GCC +GCC_WARNINGS = yes +endif +include ${top_srcdir}/warnings.mk + +libxoincdir = ${includedir}/libxo + +AM_CFLAGS = \ + -I${top_srcdir} \ + ${WARNINGS} \ + ${GETTEXT_CFLAGS} + +AM_CFLAGS += \ + -DXO_ENCODERDIR=\"${XO_ENCODERDIR}\" + +lib_LTLIBRARIES = libxo.la + +LIBS = \ + ${GETTEXT_LIBS} + +libxoinc_HEADERS = \ + xo.h \ + xo_encoder.h + +noinst_HEADERS = \ + xo_buf.h \ + xo_explicit.h \ + xo_humanize.h \ + xo_wcwidth.h + +libxo_la_SOURCES = \ + libxo.c \ + xo_encoder.c \ + xo_syslog.c + +man3_files = \ + libxo.3 \ + xo_attr.3 \ + xo_create.3 \ + xo_emit.3 \ + xo_emit_err.3 \ + xo_err.3 \ + xo_error.3 \ + xo_finish.3 \ + xo_flush.3 \ + xo_message.3 \ + xo_no_setlocale.3 \ + xo_open_container.3 \ + xo_open_list.3 \ + xo_open_marker.3 \ + xo_parse_args.3 \ + xo_set_allocator.3 \ + xo_set_flags.3 \ + xo_set_info.3 \ + xo_set_options.3 \ + xo_set_style.3 \ + xo_set_syslog_enterprise_id.3 \ + xo_set_version.3 \ + xo_set_writer.3 \ + xo_syslog.3 + +man5_files = \ + xo_format.5 + +man7_files = \ + libxo-csv.7 \ + xo_options.7 + +man_MANS = ${man3_files} ${man5_files} ${man7_files} + +EXTRA_DIST = \ + ${man_MANS} + +call-graph: + ${RM} libxo.o + ${MAKE} CC="clang -Xclang -analyze -Xclang \ + -analyzer-checker=debug.ViewCallGraph" libxo.o + +install-data-hook: + for file in ${man3_files}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man3dir}/$$file ; done + for file in ${man5_files}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man5dir}/$$file ; done + for file in ${man7_files}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man7dir}/$$file ; done diff --git a/contrib/libxo/libxo/add.man.in b/contrib/libxo/libxo/add.man.in new file mode 100644 index 000000000000..051be8a65bd2 --- /dev/null +++ b/contrib/libxo/libxo/add.man.in @@ -0,0 +1,29 @@ +.Sh ADDITIONAL DOCUMENTATION +.Fx +uses +.Nm libxo +version @LIBXO_VERSION@. +Complete documentation can be found on github: +.Bd -literal -offset indent +https://juniper.github.io/libxo/@LIBXO_VERSION@/html/index.html +.Ed +.Pp +.Nm libxo +lives on github as: +.Bd -literal -offset indent +https://github.com/Juniper/libxo +.Ed +.Pp +The latest release of +.Nm libxo +is available at: +.Bd -literal -offset indent +https://github.com/Juniper/libxo/releases +.Ed +.Sh HISTORY +The +.Nm libxo +library was added in +.Fx 11.0 . +.Sh AUTHOR +Phil Shafer diff --git a/contrib/libxo/libxo/gen-wide.sh b/contrib/libxo/libxo/gen-wide.sh new file mode 100644 index 000000000000..b0342874b179 --- /dev/null +++ b/contrib/libxo/libxo/gen-wide.sh @@ -0,0 +1,76 @@ +#!/bin/sh + +FILE=$1 + +SYMBOLS=" +xo_buffer_s +xo_buffer_t +xo_stack_s +xo_stack_t +xo_handle_s +xo_handle_t +xo_default_handle +xo_default_inited +xo_realloc +xo_free +xo_write_to_file +xo_close_file +xo_buf_init +xo_init_handle +xo_default_init +xo_buf_has_room +xo_printf +xo_escape_xml +xo_escape_json +xo_buf_append +xo_buf_escape +xo_data_append +xo_data_escape +xo_default +xo_indent +xo_warn +xo_create +xo_create_to_file +xo_destroy +xo_set_style +xo_set_flags +xo_set_info +xo_set_formatter +xo_clear_flags +xo_buf_indent +xo_line_ensure_open +xo_line_close +xo_info_compare +xo_info_find +xo_format_data +xo_buf_append_div +xo_format_text +xo_format_label +xo_format_title +xo_format_prep +xo_format_value +xo_format_decoration +xo_format_padding +xo_do_emit +xo_emit_hv +xo_emit_h +xo_emit +xo_attr_hv +xo_attr_h +xo_attr +xo_depth_change +xo_open_container_h +xo_open_container +xo_close_container_h +xo_close_container +xo_open_list_h +xo_open_list +xo_close_list_h +xo_close_list +xo_open_instance_h +xo_open_instance +xo_close_instance_h +xo_close_instance +xo_set_writer +xo_set_allocator +" diff --git a/contrib/libxo/libxo/libxo-csv.7 b/contrib/libxo/libxo/libxo-csv.7 new file mode 100644 index 000000000000..6e043820a010 --- /dev/null +++ b/contrib/libxo/libxo/libxo-csv.7 @@ -0,0 +1,274 @@ +.\" # +.\" # Copyright (c) 2021, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, May 2021 +.\" +.Dd May 13, 2021 +.Dt LIBXO-CSV 7 +.Os +.Sh NAME +.Nm --libxo encoder=csv[+options] +.Nd a CVS encoder for libxo\-based commands +.Sh DESCRIPTION +The +.Nm libxo +library supports a "pluggable" encoder mechanism, and ships with an +encoder for CSV (comma separated values) files. The encoder allows +paths and fields to be selected out of the output contents: +.Bd -literal -offset indent + % df --libxo @csv + name,total-blocks,used-blocks,available-blocks,used-percent,mounted-on + zroot/ROOT/default,3825984331,29376725,3796607605,1,/ + devfs,1,1,0,100,/dev + zroot/usr/home,3808301289,11693684,3796607605,0,/usr/home + zroot/var/audit,3796607806,201,3796607605,0,/var/audit + ... + % df --libxo @csv+leafs=name.used-percent + name,used-percent + zroot/ROOT/default,1 + devfs,100 + zroot/usr/home,0 + zroot/var/audit,0 + ... + % df --libxo @csv+leafs=available-blocks+no-header / + 3796607605 +.Ed + contains software to generate four "built-in" +formats: text, XML, JSON, and HTML. +These formats are common and useful, but there are other common and +useful formats that users will want, and including them all in the +libxo software would be difficult and cumbersome. +.Pp +To allow support for additional encodings, libxo includes a +"pluggable" extension mechanism for dynamically loading new encoders. +.Nm libxo -based +applications can automatically use any installed encoder. +.Pp +Use the "encoder=XXX" option to access encoders. The following +example uses the "cbor" encoder, saving the output into a file: +.Bd -literal -offset indent + df --libxo encoder=cbor > df-output.cbor +.Ed +.Pp +Encoders can support specific options that can be accessed by +following the encoder name with a colon (':') or a plus sign ('+') and +one of more options, separated by the same character: +.Bd -literal -offset indent + df --libxo encoder=csv+path=filesystem+leaf=name+no-header + df --libxo encoder=csv:path=filesystem:leaf=name:no-header +.Ed +.Pp +These examples instructs libxo to load the "csv" encoder and pass the +following options: +.Bd -literal -offset indent + path=filesystem + leaf=name + no-header +.Ed +.Pp +Each of these option is interpreted by the encoder, and all such +options names and semantics are specific to the particular encoder. +Refer to the intended encoder for documentation on its options. +.Pp +The string "@" can be used in place of the string "encoder=". +.Bd -literal -offset indent + df --libxo @csv:no-header +.Ed +.Sh The CSV (Comma Separated Values) Encoder +.Nm libxo +ships with a custom encoder for "CSV" files, a common format for +comma separated values. The output of the CSV encoder can be loaded +directly into spreadsheets or similar applications. +.Pp +A standard for CSV files is provided in RFC 4180, but since the +format predates that standard by decades, there are many minor +differences in CSV file consumers and their expectations. The CSV +encoder has a number of options to tailor output to those +expectations. +.Pp +Consider the following XML: +.Bd -literal -offset indent + % list-items --libxo xml,pretty + <top> + <data test="value"> + <item test2="value2"> + <sku test3="value3" key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + </item> + </data> + </top> +.Ed +.Pp +This output is a list of `instances` (named "item"), each containing a +set of `leafs` ("sku", "name", etc). +.Pp +The CSV encoder will emit the leaf values in this output as `fields` +inside a CSV `record`, which is a line containing a set of +comma-separated values: +.Bd -literal -offset indent + % list-items --libxo encoder=csv + sku,name,sold,in-stock,on-order + GRO-000-415,gum,1412,54,10 + HRD-000-212,rope,85,4,2 + HRD-000-517,ladder,0,2,1 +.Ed +.Pp +Be aware that since the CSV encoder looks for data instances, when +used with +.Nm xo , +the `--instance` option will be needed: +.Bd -literal -offset indent + % xo --libxo encoder=csv --instance foo 'The {:product} is {:status}\n' stereo "in route" + product,status + stereo,in route +.Ed +.Sh The "path" Option +By default, the CSV encoder will attempt to emit any list instance +generated by the application. +In some cases, this may be unacceptable, and a specific list may be +desired. +.Pp +Use the "path" option to limit the processing of output to a specific +hierarchy. The path should be one or more names of containers or +lists. +.Pp +For example, if the "list-items" application generates other lists, +the user can give "path=top/data/item" as a path: +.Bd -literal -offset indent + % list-items --libxo encoder=csv:path=top/data/item + sku,name,sold,in-stock,on-order + GRO-000-415,gum,1412,54,10 + HRD-000-212,rope,85,4,2 + HRD-000-517,ladder,0,2,1 +.Ed +.Pp +Paths are "relative", meaning they need not be a complete set +of names to the list. This means that "path=item" may be sufficient +for the above example. +.Sh The "leafs" Option +The CSV encoding requires that all lines of output have the same +number of fields with the same order. In contrast, XML and JSON allow +any order (though libxo forces key leafs to appear before other +leafs). +.Pp +To maintain a consistent set of fields inside the CSV file, the same +set of leafs must be selected from each list item. By default, the +CSV encoder records the set of leafs that appear in the first list +instance it processes, and extract only those leafs from future +instances. If the first instance is missing a leaf that is desired by +the consumer, the "leaf" option can be used to ensure that an empty +value is recorded for instances that lack a particular leaf. +.Pp +The "leafs" option can also be used to exclude leafs, limiting the +output to only those leafs provided. +.Pp +In addition, the order of the output fields follows the order in which +the leafs are listed. "leafs=one.two" and "leafs=two.one" give +distinct output. +.Pp +So the "leafs" option can be used to expand, limit, and order the set +of leafs. +.Pp +The value of the leafs option should be one or more leaf names, +separated by a period ("."): +.Bd -literal -offset indent + % list-items --libxo encoder=csv:leafs=sku.on-order + sku,on-order + GRO-000-415,10 + HRD-000-212,2 + HRD-000-517,1 + % list-items -libxo encoder=csv:leafs=on-order.sku + on-order,sku + 10,GRO-000-415 + 2,HRD-000-212 + 1,HRD-000-517 +.Ed +.Pp +Note that since libxo uses terminology from YANG (:RFC:`7950`), the +data modeling language for NETCONF (:RFC:`6241`), which uses "leafs" +as the plural form of "leaf". libxo follows that convention. +.Sh The "no-header" Option +CSV files typical begin with a line that defines the fields included +in that file, in an attempt to make the contents self-defining: +.Bd -literal -offset indent + sku,name,sold,in-stock,on-order + GRO-000-415,gum,1412,54,10 + HRD-000-212,rope,85,4,2 + HRD-000-517,ladder,0,2,1 +.Ed +.Pp +There is no reliable mechanism for determining whether this header +line is included, so the consumer must make an assumption. +.Pp +The csv encoder defaults to producing the header line, but the +"no-header" option can be included to avoid the header line. +.Sh The "no-quotes" Option +RFC 4180 specifies that fields containing spaces should be quoted, but +many CSV consumers do not handle quotes. The "no-quotes" option +instruct the CSV encoder to avoid the use of quotes. +.Sh The "dos" Option +RFC 4180 defines the end-of-line marker as a carriage return +followed by a newline. This "CRLF" convention dates from the distant +past, but its use was anchored in the 1980s by the `DOS` operating +system. +.Pp +The CSV encoder defaults to using the standard Unix end-of-line +marker, a simple newline. Use the "dos" option to use the `CRLF` +convention. +.Sh Option Handling +The handling of command-line options is complex, since there are three +hierarchies in use, but the rules are: +.Bl -bullet +.It +commas separate +.Nm libxo +options +.Bd -literal -ofset indent + \-\-libxo json,pretty,warn +.Ed +.It +pluses separate encoder options +.Bd -literal -ofset indent +\-\-libxo @csv+dos+no-header,warn +.Ed +.It +periods separate tag names +.Bd -literal -ofset indent +\-\-libxo @csv+leafs=name.used.free+dos,warn +.El +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xo_options 7 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +The CSV encoder first appeared in +.Fx 13.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/libxo.3 b/contrib/libxo/libxo/libxo.3 new file mode 100644 index 000000000000..95c0059865b8 --- /dev/null +++ b/contrib/libxo/libxo/libxo.3 @@ -0,0 +1,414 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 8, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm libxo +.Nd library for emitting text, XML, JSON, or HTML output +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Sh DESCRIPTION +The functions defined in +.Nm +are used to generate a choice of +.Em TEXT , +.Em XML , +.Em JSON , +or +.Em HTML +output. +A common set of functions are used, with +command line switches passed to the library to control the details of +the output. +.Pp +Most commands emit text output aimed at humans. +It is designed +to be parsed and understood by a user. +Humans are gifted at extracting +details and pattern matching. +Often programmers need to extract +information from this human-oriented output. +Programmers use tools +like +.Xr grep 1 , +.Xr awk 1 , +and regular expressions to ferret out the pieces of +information they need. +Such solutions are fragile and require +updates when output contents change or evolve, requiring testing and +validation. +.Pp +Modern tool developers favor encoding schemes like XML and JSON, +which allow trivial parsing and extraction of data. +Such formats are +simple, well understood, hierarchical, easily parsed, and often +integrate easier with common tools and environments. +.Pp +In addition, modern reality means that more output ends up in web +browsers than in terminals, making HTML output valuable. +.Pp +.Nm +allows a single set of function calls in source code to generate +traditional text output, as well as XML and JSON formatted data. +HTML +can also be generated; "<div>" elements surround the traditional text +output, with attributes that detail how to render the data. +.Pp +There are four encoding styles supported by +.Nm : +.Bl -bullet +.It +TEXT output can be display on a terminal session, allowing +compatibility with traditional command line usage. +.It +XML output is suitable for tools like XPath and protocols like +NETCONF. +.It +JSON output can be used for RESTful APIs and integration with +languages like Javascript and Python. +.It +HTML can be matched with a small CSS file to permit rendering in any +HTML5 browser. +.El +.Pp +In general, XML and JSON are suitable for encoding data, while TEXT is +suited for terminal output and HTML is suited for display in a web +browser (see +.Xr xohtml 1 ). +.Pp +.Nm libxo +uses command line options to trigger rendering behavior. +The following options are recognised: +.Pp +.Bl -tag -width "--libxo" +.It +\-\^\-libxo <options> +.It +\-\^\-libxo=<options> +.It +\-\^\-libxo:<brief-options> +.El +.Pp +Options is a comma-separated list of tokens that correspond to output +styles, flags, or features: +.Pp +.Bl -tag -width "12345678" +.It Sy "Token Action" +.It Dv dtrt +Enable "Do The Right Thing" mode +.It Dv html +Emit HTML output +.It Dv indent=xx +Set the indentation level +.It Dv info +Add info attributes (HTML) +.It Dv json +Emit JSON output +.It Dv keys +Emit the key attribute for keys (XML) +.It Dv log-gettext +Log (via stderr) each +.Xr gettext 3 +string lookup +.It Dv log-syslog +Log (via stderr) each syslog message (via +.Xr xo_syslog 3 ) +.It Dv no-humanize +Ignore the {h:} modifier (TEXT, HTML) +.It Dv no-locale +Do not initialize the locale setting +.It Dv no-retain +Prevent retaining formatting information +.It Dv no-top +Do not emit a top set of braces (JSON) +.It Dv not-first +Pretend the 1st output item was not 1st (JSON) +.It Dv pretty +Emit pretty-printed output +.It Dv retain +Force retaining formatting information +.It Dv text +Emit TEXT output +.It Dv underscores +Replace XML-friendly "-"s with JSON friendly "_"s e +.It Dv units +Add the 'units' (XML) or 'data-units (HTML) attribute +.It Dv warn +Emit warnings when libxo detects bad calls +.It Dv warn-xml +Emit warnings in XML +.It Dv xml +Emit XML output +.It Dv xpath +Add XPath expressions (HTML) +.El +.Pp +The +.Dq brief-options +are single letter commands, designed for those with +too little patience to use real tokens. +No comma separator is used. +.Bl -column "i<num>" +.It Sy "Token Action" +.It "H " "Enable HTML output (XO_STYLE_HTML)" +.It "I " "Enable info output (XOF_INFO)" +.It "i<num> " "Indent by <number>" +.It "J " "Enable JSON output (XO_STYLE_JSON)" +.It "P " "Enable pretty-printed output (XOF_PRETTY)" +.It "T " "Enable text output (XO_STYLE_TEXT)" +.It "W " "Enable warnings (XOF_WARN)" +.It "X " "Enable XML output (XO_STYLE_XML)" +.It "x " "Enable XPath data (XOF_XPATH)" +.El +.Pp +Refer to +.Xr xo_options 7 +for additional option information. +.Pp +The +.Nm +library allows an application to generate text, XML, JSON, +and HTML output using a common set of function calls. +The application +decides at run time which output style should be produced. +The +application calls a function +.Xr xo_emit 3 +to product output that is +described in a format string. +A +.Dq field descriptor +tells +.Nm +what the field is and what it means. +Each field descriptor is placed in +braces with a printf-like format string: +.Bd -literal -offset indent + xo_emit(" {:lines/%7ju} {:words/%7ju} " + "{:characters/%7ju}{d:filename/%s}\\n", + linect, wordct, charct, file); +.Ed +.Pp +Each field can have a role, with the 'value' role being the default, +and the role tells +.Nm +how and when to render that field, as well as +a +.Xr printf 3 Ns -like +format string. +.Pp +Output +can then be generated in various style, using the "--libxo" option. +.Sh DEFAULT HANDLE +Handles give an abstraction for +.Nm +that encapsulates the state of a +stream of output. +Handles have the data type "xo_handle_t" and are +opaque to the caller. +.Pp +The library has a default handle that is automatically initialized. +By default, this handle will send text style output to standard output. +The +.Xr xo_set_style 3 +and +.Xr xo_set_flags 3 +functions can be used to change this +behavior. +.Pp +Many +.Nm +functions take a handle as their first parameter; most that +do not use the default handle. +Any function taking a handle can +be passed +.Dv NULL +to access the default handle. +.Pp +For the typical command that is generating output on standard output, +there is no need to create an explicit handle, but they are available +when needed, e.g., for daemons that generate multiple streams of +output. +.Sh FUNCTION OVERVIEW +The +.Nm +library includes the following functions: +.Bl -tag -width "xo_close_container_hd" +.It Sy "Function Description" +.It Fn xo_attr +.It Fn xo_attr_h +.It Fn xo_attr_hv +Allows the caller to emit XML attributes with the next open element. +.It Fn xo_create +.It Fn xo_create_to_file +Allow the caller to create a new handle. +Note that +.Nm +has a default handle that allows the caller to avoid use of an +explicitly created handle. +Only callers writing to files other than +.Dv stdout +would need to call +.Fn xo_create . +.It Fn xo_destroy +Frees any resources associated with the handle, including the handle +itself. +.It Fn xo_emit +.It Fn xo_emit_h +.It Fn xo_emit_hv +Emit formatted output. +The +.Fa fmt +string controls the conversion of the remaining arguments into +formatted output. +See +.Xr xo_format 5 +for details. +.It Fn xo_emit_warn +.It Fn xo_emit_warnx +.It Fn xo_emit_warn_c +.It Fn xo_emit_warn_hc +.It Fn xo_emit_err +.It Fn xo_emit_errc +.It Fn xo_emit_errx +These functions are mildly compatible with their standard libc +namesakes, but use the format string defined in +.Xr xo_format 5 . +While there is an increased cost for converting the strings, the +output provided can be richer and more useful. See also +.Xr xo_err 3 +.It Fn xo_warn +.It Fn xo_warnx +.It Fn xo_warn_c +.It Fn xo_warn_hc +.It Fn xo_err +.It Fn xo_errc +.It Fn xo_errx +.It Fn xo_message +.It Fn xo_message_c +.It Fn xo_message_hc +.It Fn xo_message_hcv +These functions are meant to be compatible with their standard libc namesakes. +.It Fn xo_finish +.It Fn xo_finish_h +Flush output, close open construct, and complete any pending +operations. +.It Fn xo_flush +.It Fn xo_flush_h +Allow the caller to flush any pending output for a handle. +.It Fn xo_no_setlocale +Direct +.Nm +to avoid initializing the locale. +This function should be called before any other +.Nm +function is called. +.It Fn xo_open_container +.It Fn xo_open_container_h +.It Fn xo_open_container_hd +.It Fn xo_open_container_d +.It Fn xo_close_container +.It Fn xo_close_container_h +.It Fn xo_close_container_hd +.It Fn xo_close_container_d +Containers a singleton levels of hierarchy, typically used to organize +related content. +.It Fn xo_open_list_h +.It Fn xo_open_list +.It Fn xo_open_list_hd +.It Fn xo_open_list_d +.It Fn xo_open_instance_h +.It Fn xo_open_instance +.It Fn xo_open_instance_hd +.It Fn xo_open_instance_d +.It Fn xo_close_instance_h +.It Fn xo_close_instance +.It Fn xo_close_instance_hd +.It Fn xo_close_instance_d +.It Fn xo_close_list_h +.It Fn xo_close_list +.It Fn xo_close_list_hd +.It Fn xo_close_list_d +Lists are levels of hierarchy that can appear multiple times within +the same parent. +Two calls are needed to encapsulate them, one for +the list and one for each instance of that list. +Typically +.Fn xo_open_list +and +.Fn xo_close_list +are called outside a +for-loop, where +.Fn xo_open_instance +it called at the top of the loop, and +.Fn xo_close_instance +is called at the bottom of the loop. +.It Fn xo_parse_args +Inspects command line arguments for directions to +.Nm . +This function should be called before +.Va argv +is inspected by the application. +.It Fn xo_set_allocator +Instructs +.Nm +to use an alternative memory allocator and deallocator. +.It Fn xo_set_flags +.It Fn xo_clear_flags +Change the flags set for a handle. +.It Fn xo_set_info +Provides additional information about elements for use with HTML +rendering. +.It Fn xo_set_options +Changes formatting options used by handle. +.It Fn xo_set_style +.It Fn xo_set_style_name +Changes the output style used by a handle. +.It Fn xo_set_writer +Instructs +.Nm +to use an alternative set of low-level output functions. +.El +.Sh SEE ALSO +.Xr libxo-csv 7, +.Xr xo 1 , +.Xr xolint 1 , +.Xr xo_attr 3 , +.Xr xo_create 3 , +.Xr xo_emit 3 , +.Xr xo_emit_err 3 , +.Xr xo_err 3 , +.Xr xo_finish 3 , +.Xr xo_flush 3 , +.Xr xo_no_setlocale 3 , +.Xr xo_open_container 3 , +.Xr xo_open_list 3 , +.Xr xo_options 7, +.Xr xo_parse_args 3 , +.Xr xo_set_allocator 3 , +.Xr xo_set_flags 3 , +.Xr xo_set_info 3 , +.Xr xo_set_options 3 , +.Xr xo_set_style 3 , +.Xr xo_set_writer 3 , +.Xr xo_format 5 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/libxo.c b/contrib/libxo/libxo/libxo.c new file mode 100644 index 000000000000..916a111f5af2 --- /dev/null +++ b/contrib/libxo/libxo/libxo.c @@ -0,0 +1,8544 @@ +/* + * Copyright (c) 2014-2019, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + * + * This is the implementation of libxo, the formatting library that + * generates multiple styles of output from a single code path. + * Command line utilities can have their normal text output while + * automation tools can see XML or JSON output, and web tools can use + * HTML output that encodes the text output annotated with additional + * information. Specialized encoders can be built that allow custom + * encoding including binary ones like CBOR, thrift, protobufs, etc. + * + * Full documentation is available in ./doc/libxo.txt or online at: + * http://juniper.github.io/libxo/libxo-manual.html + * + * For first time readers, the core bits of code to start looking at are: + * - xo_do_emit() -- parse and emit a set of fields + * - xo_do_emit_fields -- the central function of the library + * - xo_do_format_field() -- handles formatting a single field + * - xo_transiton() -- the state machine that keeps things sane + * and of course the "xo_handle_t" data structure, which carries all + * configuration and state. + */ + +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#include <unistd.h> +#include <stddef.h> +#include <wchar.h> +#include <locale.h> +#include <sys/types.h> +#include <stdarg.h> +#include <string.h> +#include <errno.h> +#include <limits.h> +#include <ctype.h> +#include <wctype.h> +#include <getopt.h> + +#include "xo_config.h" +#include "xo.h" +#include "xo_encoder.h" +#include "xo_buf.h" +#include "xo_explicit.h" + +/* + * We ask wcwidth() to do an impossible job, really. It's supposed to + * need to tell us the number of columns consumed to display a unicode + * character. It returns that number without any sort of context, but + * we know they are characters whose glyph differs based on placement + * (end of word, middle of word, etc) and many that affect characters + * previously emitted. Without content, it can't hope to tell us. + * But it's the only standard tool we've got, so we use it. We would + * use wcswidth() but it typically just loops through adding the results + * of wcwidth() calls in an entirely unhelpful way. + * + * Even then, there are many poor implementations (macosx), so we have + * to carry our own. We could have configure.ac test this (with + * something like 'assert(wcwidth(0x200d) == 0)'), but it would have + * to run a binary, which breaks cross-compilation. Hmm... I could + * run this test at init time and make a warning for our dear user. + * + * Anyhow, it remains a best-effort sort of thing. And it's all made + * more hopeless because we assume the display code doing the rendering is + * playing by the same rules we are. If it display 0x200d as a square + * box or a funky question mark, the output will be hosed. + */ +#ifdef LIBXO_WCWIDTH +#include "xo_wcwidth.h" +#else /* LIBXO_WCWIDTH */ +#define xo_wcwidth(_x) wcwidth(_x) +#endif /* LIBXO_WCWIDTH */ + +#ifdef HAVE_STDIO_EXT_H +#include <stdio_ext.h> +#endif /* HAVE_STDIO_EXT_H */ + +/* + * humanize_number is a great function, unless you don't have it. So + * we carry one in our pocket. + */ +#ifdef HAVE_HUMANIZE_NUMBER +#include <libutil.h> +#define xo_humanize_number humanize_number +#else /* HAVE_HUMANIZE_NUMBER */ +#include "xo_humanize.h" +#endif /* HAVE_HUMANIZE_NUMBER */ + +#ifdef HAVE_GETTEXT +#include <libintl.h> +#endif /* HAVE_GETTEXT */ + +/* Rather lame that we can't count on these... */ +#ifndef FALSE +#define FALSE 0 +#endif +#ifndef TRUE +#define TRUE 1 +#endif + +/* + * Three styles of specifying thread-local variables are supported. + * configure.ac has the brains to run each possibility through the + * compiler and see what works; we are left to define the THREAD_LOCAL + * macro to the right value. Most toolchains (clang, gcc) use + * "before", but some (borland) use "after" and I've heard of some + * (ms) that use __declspec. Any others out there? + */ +#define THREAD_LOCAL_before 1 +#define THREAD_LOCAL_after 2 +#define THREAD_LOCAL_declspec 3 + +#ifndef HAVE_THREAD_LOCAL +#define THREAD_LOCAL(_x) _x +#elif HAVE_THREAD_LOCAL == THREAD_LOCAL_before +#define THREAD_LOCAL(_x) __thread _x +#elif HAVE_THREAD_LOCAL == THREAD_LOCAL_after +#define THREAD_LOCAL(_x) _x __thread +#elif HAVE_THREAD_LOCAL == THREAD_LOCAL_declspec +#define THREAD_LOCAL(_x) __declspec(_x) +#else +#error unknown thread-local setting +#endif /* HAVE_THREADS_H */ + +const char xo_version[] = LIBXO_VERSION; +const char xo_version_extra[] = LIBXO_VERSION_EXTRA; +static const char xo_default_format[] = "%s"; + +#ifndef UNUSED +#define UNUSED __attribute__ ((__unused__)) +#endif /* UNUSED */ + +#define XO_INDENT_BY 2 /* Amount to indent when pretty printing */ +#define XO_DEPTH 128 /* Default stack depth */ +#define XO_MAX_ANCHOR_WIDTH (8*1024) /* Anything wider is just silly */ + +#define XO_FAILURE_NAME "failure" + +/* Flags for the stack frame */ +typedef unsigned xo_xsf_flags_t; /* XSF_* flags */ +#define XSF_NOT_FIRST (1<<0) /* Not the first element */ +#define XSF_LIST (1<<1) /* Frame is a list */ +#define XSF_INSTANCE (1<<2) /* Frame is an instance */ +#define XSF_DTRT (1<<3) /* Save the name for DTRT mode */ + +#define XSF_CONTENT (1<<4) /* Some content has been emitted */ +#define XSF_EMIT (1<<5) /* Some field has been emitted */ +#define XSF_EMIT_KEY (1<<6) /* A key has been emitted */ +#define XSF_EMIT_LEAF_LIST (1<<7) /* A leaf-list field has been emitted */ + +/* These are the flags we propagate between markers and their parents */ +#define XSF_MARKER_FLAGS \ + (XSF_NOT_FIRST | XSF_CONTENT | XSF_EMIT | XSF_EMIT_KEY | XSF_EMIT_LEAF_LIST ) + +/* + * Turn the transition between two states into a number suitable for + * a "switch" statement. + */ +#define XSS_TRANSITION(_old, _new) ((_old) << 8 | (_new)) + +/* + * xo_stack_t: As we open and close containers and levels, we + * create a stack of frames to track them. This is needed for + * XOF_WARN and XOF_XPATH. + */ +typedef struct xo_stack_s { + xo_xsf_flags_t xs_flags; /* Flags for this frame */ + xo_state_t xs_state; /* State for this stack frame */ + char *xs_name; /* Name (for XPath value) */ + char *xs_keys; /* XPath predicate for any key fields */ +} xo_stack_t; + +/* + * libxo supports colors and effects, for those who like them. + * XO_COL_* ("colors") refers to fancy ansi codes, while X__EFF_* + * ("effects") are bits since we need to maintain state. + */ +typedef uint8_t xo_color_t; +#define XO_COL_DEFAULT 0 +#define XO_COL_BLACK 1 +#define XO_COL_RED 2 +#define XO_COL_GREEN 3 +#define XO_COL_YELLOW 4 +#define XO_COL_BLUE 5 +#define XO_COL_MAGENTA 6 +#define XO_COL_CYAN 7 +#define XO_COL_WHITE 8 + +#define XO_NUM_COLORS 9 + +/* + * Yes, there's no blink. We're civilized. We like users. Blink + * isn't something one does to someone you like. Friends don't let + * friends use blink. On friends. You know what I mean. Blink is + * like, well, it's like bursting into show tunes at a funeral. It's + * just not done. Not something anyone wants. And on those rare + * instances where it might actually be appropriate, it's still wrong, + * since it's likely done by the wrong person for the wrong reason. + * Just like blink. And if I implemented blink, I'd be like a funeral + * director who adds "Would you like us to burst into show tunes?" on + * the list of questions asked while making funeral arrangements. + * It's formalizing wrongness in the wrong way. And we're just too + * civilized to do that. Hhhmph! + */ +#define XO_EFF_RESET (1<<0) +#define XO_EFF_NORMAL (1<<1) +#define XO_EFF_BOLD (1<<2) +#define XO_EFF_UNDERLINE (1<<3) +#define XO_EFF_INVERSE (1<<4) + +#define XO_EFF_CLEAR_BITS XO_EFF_RESET /* Reset gets reset, surprisingly */ + +typedef uint8_t xo_effect_t; +typedef struct xo_colors_s { + xo_effect_t xoc_effects; /* Current effect set */ + xo_color_t xoc_col_fg; /* Foreground color */ + xo_color_t xoc_col_bg; /* Background color */ +} xo_colors_t; + +/* + * xo_handle_t: this is the principle data structure for libxo. + * It's used as a store for state, options, content, and all manor + * of other information. + */ +struct xo_handle_s { + xo_xof_flags_t xo_flags; /* Flags (XOF_*) from the user*/ + xo_xof_flags_t xo_iflags; /* Internal flags (XOIF_*) */ + xo_style_t xo_style; /* XO_STYLE_* value */ + unsigned short xo_indent; /* Indent level (if pretty) */ + unsigned short xo_indent_by; /* Indent amount (tab stop) */ + xo_write_func_t xo_write; /* Write callback */ + xo_close_func_t xo_close; /* Close callback */ + xo_flush_func_t xo_flush; /* Flush callback */ + xo_formatter_t xo_formatter; /* Custom formating function */ + xo_checkpointer_t xo_checkpointer; /* Custom formating support function */ + void *xo_opaque; /* Opaque data for write function */ + xo_buffer_t xo_data; /* Output data */ + xo_buffer_t xo_fmt; /* Work area for building format strings */ + xo_buffer_t xo_attrs; /* Work area for building XML attributes */ + xo_buffer_t xo_predicate; /* Work area for building XPath predicates */ + xo_stack_t *xo_stack; /* Stack pointer */ + int xo_depth; /* Depth of stack */ + int xo_stack_size; /* Size of the stack */ + xo_info_t *xo_info; /* Info fields for all elements */ + int xo_info_count; /* Number of info entries */ + va_list xo_vap; /* Variable arguments (stdargs) */ + char *xo_leading_xpath; /* A leading XPath expression */ + mbstate_t xo_mbstate; /* Multi-byte character conversion state */ + ssize_t xo_anchor_offset; /* Start of anchored text */ + ssize_t xo_anchor_columns; /* Number of columns since the start anchor */ + ssize_t xo_anchor_min_width; /* Desired width of anchored text */ + ssize_t xo_units_offset; /* Start of units insertion point */ + ssize_t xo_columns; /* Columns emitted during this xo_emit call */ +#ifndef LIBXO_TEXT_ONLY + xo_color_t xo_color_map_fg[XO_NUM_COLORS]; /* Foreground color mappings */ + xo_color_t xo_color_map_bg[XO_NUM_COLORS]; /* Background color mappings */ +#endif /* LIBXO_TEXT_ONLY */ + xo_colors_t xo_colors; /* Current color and effect values */ + xo_buffer_t xo_color_buf; /* HTML: buffer of colors and effects */ + char *xo_version; /* Version string */ + int xo_errno; /* Saved errno for "%m" */ + char *xo_gt_domain; /* Gettext domain, suitable for dgettext(3) */ + xo_encoder_func_t xo_encoder; /* Encoding function */ + void *xo_private; /* Private data for external encoders */ +}; + +/* Flag operations */ +#define XOF_BIT_ISSET(_flag, _bit) (((_flag) & (_bit)) ? 1 : 0) +#define XOF_BIT_SET(_flag, _bit) do { (_flag) |= (_bit); } while (0) +#define XOF_BIT_CLEAR(_flag, _bit) do { (_flag) &= ~(_bit); } while (0) + +#define XOF_ISSET(_xop, _bit) XOF_BIT_ISSET(_xop->xo_flags, _bit) +#define XOF_SET(_xop, _bit) XOF_BIT_SET(_xop->xo_flags, _bit) +#define XOF_CLEAR(_xop, _bit) XOF_BIT_CLEAR(_xop->xo_flags, _bit) + +#define XOIF_ISSET(_xop, _bit) XOF_BIT_ISSET(_xop->xo_iflags, _bit) +#define XOIF_SET(_xop, _bit) XOF_BIT_SET(_xop->xo_iflags, _bit) +#define XOIF_CLEAR(_xop, _bit) XOF_BIT_CLEAR(_xop->xo_iflags, _bit) + +/* Internal flags */ +#define XOIF_REORDER XOF_BIT(0) /* Reordering fields; record field info */ +#define XOIF_DIV_OPEN XOF_BIT(1) /* A <div> is open */ +#define XOIF_TOP_EMITTED XOF_BIT(2) /* The top JSON braces have been emitted */ +#define XOIF_ANCHOR XOF_BIT(3) /* An anchor is in place */ + +#define XOIF_UNITS_PENDING XOF_BIT(4) /* We have a units-insertion pending */ +#define XOIF_INIT_IN_PROGRESS XOF_BIT(5) /* Init of handle is in progress */ +#define XOIF_MADE_OUTPUT XOF_BIT(6) /* Have already made output */ + +/* + * Normal printf has width and precision, which for strings operate as + * min and max number of columns. But this depends on the idea that + * one byte means one column, which UTF-8 and multi-byte characters + * pitches on its ear. It may take 40 bytes of data to populate 14 + * columns, but we can't go off looking at 40 bytes of data without the + * caller's permission for fear/knowledge that we'll generate core files. + * + * So we make three values, distinguishing between "max column" and + * "number of bytes that we will inspect inspect safely" We call the + * later "size", and make the format "%[[<min>].[[<size>].<max>]]s". + * + * Under the "first do no harm" theory, we default "max" to "size". + * This is a reasonable assumption for folks that don't grok the + * MBS/WCS/UTF-8 world, and while it will be annoying, it will never + * be evil. + * + * For example, xo_emit("{:tag/%-14.14s}", buf) will make 14 + * columns of output, but will never look at more than 14 bytes of the + * input buffer. This is mostly compatible with printf and caller's + * expectations. + * + * In contrast xo_emit("{:tag/%-14..14s}", buf) will look at however + * many bytes (or until a NUL is seen) are needed to fill 14 columns + * of output. xo_emit("{:tag/%-14.*.14s}", xx, buf) will look at up + * to xx bytes (or until a NUL is seen) in order to fill 14 columns + * of output. + * + * It's fairly amazing how a good idea (handle all languages of the + * world) blows such a big hole in the bottom of the fairly weak boat + * that is C string handling. The simplicity and completenesss are + * sunk in ways we haven't even begun to understand. + */ +#define XF_WIDTH_MIN 0 /* Minimal width */ +#define XF_WIDTH_SIZE 1 /* Maximum number of bytes to examine */ +#define XF_WIDTH_MAX 2 /* Maximum width */ +#define XF_WIDTH_NUM 3 /* Numeric fields in printf (min.size.max) */ + +/* Input and output string encodings */ +#define XF_ENC_WIDE 1 /* Wide characters (wchar_t) */ +#define XF_ENC_UTF8 2 /* UTF-8 */ +#define XF_ENC_LOCALE 3 /* Current locale */ + +/* + * A place to parse printf-style format flags for each field + */ +typedef struct xo_format_s { + unsigned char xf_fc; /* Format character */ + unsigned char xf_enc; /* Encoding of the string (XF_ENC_*) */ + unsigned char xf_skip; /* Skip this field */ + unsigned char xf_lflag; /* 'l' (long) */ + unsigned char xf_hflag;; /* 'h' (half) */ + unsigned char xf_jflag; /* 'j' (intmax_t) */ + unsigned char xf_tflag; /* 't' (ptrdiff_t) */ + unsigned char xf_zflag; /* 'z' (size_t) */ + unsigned char xf_qflag; /* 'q' (quad_t) */ + unsigned char xf_seen_minus; /* Seen a minus */ + int xf_leading_zero; /* Seen a leading zero (zero fill) */ + unsigned xf_dots; /* Seen one or more '.'s */ + int xf_width[XF_WIDTH_NUM]; /* Width/precision/size numeric fields */ + unsigned xf_stars; /* Seen one or more '*'s */ + unsigned char xf_star[XF_WIDTH_NUM]; /* Seen one or more '*'s */ +} xo_format_t; + +/* + * This structure represents the parsed field information, suitable for + * processing by xo_do_emit and anything else that needs to parse fields. + * Note that all pointers point to the main format string. + * + * XXX This is a first step toward compilable or cachable format + * strings. We can also cache the results of dgettext when no format + * is used, assuming the 'p' modifier has _not_ been set. + */ +typedef struct xo_field_info_s { + xo_xff_flags_t xfi_flags; /* Flags for this field */ + unsigned xfi_ftype; /* Field type, as character (e.g. 'V') */ + const char *xfi_start; /* Start of field in the format string */ + const char *xfi_content; /* Field's content */ + const char *xfi_format; /* Field's Format */ + const char *xfi_encoding; /* Field's encoding format */ + const char *xfi_next; /* Next character in format string */ + ssize_t xfi_len; /* Length of field */ + ssize_t xfi_clen; /* Content length */ + ssize_t xfi_flen; /* Format length */ + ssize_t xfi_elen; /* Encoding length */ + unsigned xfi_fnum; /* Field number (if used; 0 otherwise) */ + unsigned xfi_renum; /* Reordered number (0 == no renumbering) */ +} xo_field_info_t; + +/* + * We keep a 'default' handle to allow callers to avoid having to + * allocate one. Passing NULL to any of our functions will use + * this default handle. Most functions have a variant that doesn't + * require a handle at all, since most output is to stdout, which + * the default handle handles handily. + */ +static THREAD_LOCAL(xo_handle_t) xo_default_handle; +static THREAD_LOCAL(int) xo_default_inited; +static int xo_locale_inited; +static const char *xo_program; + +/* + * To allow libxo to be used in diverse environment, we allow the + * caller to give callbacks for memory allocation. + */ +xo_realloc_func_t xo_realloc = realloc; +xo_free_func_t xo_free = free; + +/* Forward declarations */ +static ssize_t +xo_transition (xo_handle_t *xop, xo_xof_flags_t flags, const char *name, + xo_state_t new_state); + +static int +xo_set_options_simple (xo_handle_t *xop, const char *input); + +static int +xo_color_find (const char *str); + +static void +xo_buf_append_div (xo_handle_t *xop, const char *class, xo_xff_flags_t flags, + const char *name, ssize_t nlen, + const char *value, ssize_t vlen, + const char *fmt, ssize_t flen, + const char *encoding, ssize_t elen); + +static void +xo_anchor_clear (xo_handle_t *xop); + +/* + * xo_style is used to retrieve the current style. When we're built + * for "text only" mode, we use this function to drive the removal + * of most of the code in libxo. We return a constant and the compiler + * happily removes the non-text code that is not longer executed. This + * trims our code nicely without needing to trampel perfectly readable + * code with ifdefs. + */ +static inline xo_style_t +xo_style (xo_handle_t *xop UNUSED) +{ +#ifdef LIBXO_TEXT_ONLY + return XO_STYLE_TEXT; +#else /* LIBXO_TEXT_ONLY */ + return xop->xo_style; +#endif /* LIBXO_TEXT_ONLY */ +} + +/* + * Allow the compiler to optimize out non-text-only code while + * still compiling it. + */ +static inline int +xo_text_only (void) +{ +#ifdef LIBXO_TEXT_ONLY + return TRUE; +#else /* LIBXO_TEXT_ONLY */ + return FALSE; +#endif /* LIBXO_TEXT_ONLY */ +} + +/* + * Callback to write data to a FILE pointer + */ +static xo_ssize_t +xo_write_to_file (void *opaque, const char *data) +{ + FILE *fp = (FILE *) opaque; + + return fprintf(fp, "%s", data); +} + +/* + * Callback to close a file + */ +static void +xo_close_file (void *opaque) +{ + FILE *fp = (FILE *) opaque; + + fclose(fp); +} + +/* + * Callback to flush a FILE pointer + */ +static int +xo_flush_file (void *opaque) +{ + FILE *fp = (FILE *) opaque; + + return fflush(fp); +} + +/* + * Use a rotating stock of buffers to make a printable string + */ +#define XO_NUMBUFS 8 +#define XO_SMBUFSZ 128 + +static const char * +xo_printable (const char *str) +{ + static THREAD_LOCAL(char) bufset[XO_NUMBUFS][XO_SMBUFSZ]; + static THREAD_LOCAL(int) bufnum = 0; + + if (str == NULL) + return ""; + + if (++bufnum == XO_NUMBUFS) + bufnum = 0; + + char *res = bufset[bufnum], *cp, *ep; + + for (cp = res, ep = res + XO_SMBUFSZ - 1; *str && cp < ep; cp++, str++) { + if (*str == '\n') { + *cp++ = '\\'; + *cp = 'n'; + } else if (*str == '\r') { + *cp++ = '\\'; + *cp = 'r'; + } else if (*str == '\"') { + *cp++ = '\\'; + *cp = '"'; + } else + *cp = *str; + } + + *cp = '\0'; + return res; +} + +static int +xo_depth_check (xo_handle_t *xop, int depth) +{ + xo_stack_t *xsp; + + if (depth >= xop->xo_stack_size) { + depth += XO_DEPTH; /* Extra room */ + + xsp = xo_realloc(xop->xo_stack, sizeof(xop->xo_stack[0]) * depth); + if (xsp == NULL) { + xo_failure(xop, "xo_depth_check: out of memory (%d)", depth); + return -1; + } + + int count = depth - xop->xo_stack_size; + + bzero(xsp + xop->xo_stack_size, count * sizeof(*xsp)); + xop->xo_stack_size = depth; + xop->xo_stack = xsp; + } + + return 0; +} + +void +xo_no_setlocale (void) +{ + xo_locale_inited = 1; /* Skip initialization */ +} + +/* + * For XML, the first character of a tag cannot be numeric, but people + * will likely not notice. So we people-proof them by forcing a leading + * underscore if they use invalid tags. Note that this doesn't cover + * all broken tags, just this fairly specific case. + */ +static const char * +xo_xml_leader_len (xo_handle_t *xop, const char *name, xo_ssize_t nlen) +{ + if (name == NULL || isalpha(name[0]) || name[0] == '_') + return ""; + + xo_failure(xop, "invalid XML tag name: '%.*s'", nlen, name); + return "_"; +} + +static const char * +xo_xml_leader (xo_handle_t *xop, const char *name) +{ + return xo_xml_leader_len(xop, name, strlen(name)); +} + +/* + * We need to decide if stdout is line buffered (_IOLBF). Lacking a + * standard way to decide this (e.g. getlinebuf()), we have configure + * look to find __flbf, which glibc supported. If not, we'll rely on + * isatty, with the assumption that terminals are the only thing + * that's line buffered. We _could_ test for "steam._flags & _IOLBF", + * which is all __flbf does, but that's even tackier. Like a + * bedazzled Elvis outfit on an ugly lap dog sort of tacky. Not + * something we're willing to do. + */ +static int +xo_is_line_buffered (FILE *stream) +{ +#if HAVE___FLBF + if (__flbf(stream)) + return 1; +#else /* HAVE___FLBF */ + if (isatty(fileno(stream))) + return 1; +#endif /* HAVE___FLBF */ + return 0; +} + +/* + * Initialize an xo_handle_t, using both static defaults and + * the global settings from the LIBXO_OPTIONS environment + * variable. + */ +static void +xo_init_handle (xo_handle_t *xop) +{ + xop->xo_opaque = stdout; + xop->xo_write = xo_write_to_file; + xop->xo_flush = xo_flush_file; + + if (xo_is_line_buffered(stdout)) + XOF_SET(xop, XOF_FLUSH_LINE); + + /* + * We need to initialize the locale, which isn't really pretty. + * Libraries should depend on their caller to set up the + * environment. But we really can't count on the caller to do + * this, because well, they won't. Trust me. + */ + if (!xo_locale_inited) { + xo_locale_inited = 1; /* Only do this once */ + +#ifdef __FreeBSD__ /* Who does The Right Thing */ + const char *cp = ""; +#else /* __FreeBSD__ */ + const char *cp = getenv("LC_ALL"); + if (cp == NULL) + cp = getenv("LC_CTYPE"); + if (cp == NULL) + cp = getenv("LANG"); + if (cp == NULL) + cp = "C"; /* Default for C programs */ +#endif /* __FreeBSD__ */ + + (void) setlocale(LC_CTYPE, cp); + } + + /* + * Initialize only the xo_buffers we know we'll need; the others + * can be allocated as needed. + */ + xo_buf_init(&xop->xo_data); + xo_buf_init(&xop->xo_fmt); + + if (XOIF_ISSET(xop, XOIF_INIT_IN_PROGRESS)) + return; + XOIF_SET(xop, XOIF_INIT_IN_PROGRESS); + + xop->xo_indent_by = XO_INDENT_BY; + xo_depth_check(xop, XO_DEPTH); + + XOIF_CLEAR(xop, XOIF_INIT_IN_PROGRESS); +} + +/* + * Initialize the default handle. + */ +static void +xo_default_init (void) +{ + xo_handle_t *xop = &xo_default_handle; + + xo_init_handle(xop); + +#if !defined(NO_LIBXO_OPTIONS) + if (!XOF_ISSET(xop, XOF_NO_ENV)) { + char *env = getenv("LIBXO_OPTIONS"); + + if (env) + xo_set_options_simple(xop, env); + + } +#endif /* NO_LIBXO_OPTIONS */ + + xo_default_inited = 1; +} + +/* + * Cheap convenience function to return either the argument, or + * the internal handle, after it has been initialized. The usage + * is: + * xop = xo_default(xop); + */ +static xo_handle_t * +xo_default (xo_handle_t *xop) +{ + if (xop == NULL) { + if (xo_default_inited == 0) + xo_default_init(); + xop = &xo_default_handle; + } + + return xop; +} + +/* + * Return the number of spaces we should be indenting. If + * we are pretty-printing, this is indent * indent_by. + */ +static int +xo_indent (xo_handle_t *xop) +{ + int rc = 0; + + xop = xo_default(xop); + + if (XOF_ISSET(xop, XOF_PRETTY)) { + rc = xop->xo_indent * xop->xo_indent_by; + if (XOIF_ISSET(xop, XOIF_TOP_EMITTED)) + rc += xop->xo_indent_by; + } + + return (rc > 0) ? rc : 0; +} + +static void +xo_buf_indent (xo_handle_t *xop, int indent) +{ + xo_buffer_t *xbp = &xop->xo_data; + + if (indent <= 0) + indent = xo_indent(xop); + + if (!xo_buf_has_room(xbp, indent)) + return; + + memset(xbp->xb_curp, ' ', indent); + xbp->xb_curp += indent; +} + +static char xo_xml_amp[] = "&"; +static char xo_xml_lt[] = "<"; +static char xo_xml_gt[] = ">"; +static char xo_xml_quot[] = """; + +static ssize_t +xo_escape_xml (xo_buffer_t *xbp, ssize_t len, xo_xff_flags_t flags) +{ + ssize_t slen; + ssize_t delta = 0; + char *cp, *ep, *ip; + const char *sp; + int attr = XOF_BIT_ISSET(flags, XFF_ATTR); + + for (cp = xbp->xb_curp, ep = cp + len; cp < ep; cp++) { + /* We're subtracting 2: 1 for the NUL, 1 for the char we replace */ + if (*cp == '<') + delta += sizeof(xo_xml_lt) - 2; + else if (*cp == '>') + delta += sizeof(xo_xml_gt) - 2; + else if (*cp == '&') + delta += sizeof(xo_xml_amp) - 2; + else if (attr && *cp == '"') + delta += sizeof(xo_xml_quot) - 2; + } + + if (delta == 0) /* Nothing to escape; bail */ + return len; + + if (!xo_buf_has_room(xbp, delta)) /* No room; bail, but don't append */ + return 0; + + ep = xbp->xb_curp; + cp = ep + len; + ip = cp + delta; + do { + cp -= 1; + ip -= 1; + + if (*cp == '<') + sp = xo_xml_lt; + else if (*cp == '>') + sp = xo_xml_gt; + else if (*cp == '&') + sp = xo_xml_amp; + else if (attr && *cp == '"') + sp = xo_xml_quot; + else { + *ip = *cp; + continue; + } + + slen = strlen(sp); + ip -= slen - 1; + memcpy(ip, sp, slen); + + } while (cp > ep && cp != ip); + + return len + delta; +} + +static ssize_t +xo_escape_json (xo_buffer_t *xbp, ssize_t len, xo_xff_flags_t flags UNUSED) +{ + ssize_t delta = 0; + char *cp, *ep, *ip; + + for (cp = xbp->xb_curp, ep = cp + len; cp < ep; cp++) { + if (*cp == '\\' || *cp == '"') + delta += 1; + else if (*cp == '\n' || *cp == '\r') + delta += 1; + } + + if (delta == 0) /* Nothing to escape; bail */ + return len; + + if (!xo_buf_has_room(xbp, delta)) /* No room; bail, but don't append */ + return 0; + + ep = xbp->xb_curp; + cp = ep + len; + ip = cp + delta; + do { + cp -= 1; + ip -= 1; + + if (*cp == '\\' || *cp == '"') { + *ip-- = *cp; + *ip = '\\'; + } else if (*cp == '\n') { + *ip-- = 'n'; + *ip = '\\'; + } else if (*cp == '\r') { + *ip-- = 'r'; + *ip = '\\'; + } else { + *ip = *cp; + } + + } while (cp > ep && cp != ip); + + return len + delta; +} + +/* + * PARAM-VALUE = UTF-8-STRING ; characters '"', '\' and + * ; ']' MUST be escaped. + */ +static ssize_t +xo_escape_sdparams (xo_buffer_t *xbp, ssize_t len, xo_xff_flags_t flags UNUSED) +{ + ssize_t delta = 0; + char *cp, *ep, *ip; + + for (cp = xbp->xb_curp, ep = cp + len; cp < ep; cp++) { + if (*cp == '\\' || *cp == '"' || *cp == ']') + delta += 1; + } + + if (delta == 0) /* Nothing to escape; bail */ + return len; + + if (!xo_buf_has_room(xbp, delta)) /* No room; bail, but don't append */ + return 0; + + ep = xbp->xb_curp; + cp = ep + len; + ip = cp + delta; + do { + cp -= 1; + ip -= 1; + + if (*cp == '\\' || *cp == '"' || *cp == ']') { + *ip-- = *cp; + *ip = '\\'; + } else { + *ip = *cp; + } + + } while (cp > ep && cp != ip); + + return len + delta; +} + +static void +xo_buf_escape (xo_handle_t *xop, xo_buffer_t *xbp, + const char *str, ssize_t len, xo_xff_flags_t flags) +{ + if (!xo_buf_has_room(xbp, len)) + return; + + memcpy(xbp->xb_curp, str, len); + + switch (xo_style(xop)) { + case XO_STYLE_XML: + case XO_STYLE_HTML: + len = xo_escape_xml(xbp, len, flags); + break; + + case XO_STYLE_JSON: + len = xo_escape_json(xbp, len, flags); + break; + + case XO_STYLE_SDPARAMS: + len = xo_escape_sdparams(xbp, len, flags); + break; + } + + xbp->xb_curp += len; +} + +/* + * Write the current contents of the data buffer using the handle's + * xo_write function. + */ +static ssize_t +xo_write (xo_handle_t *xop) +{ + ssize_t rc = 0; + xo_buffer_t *xbp = &xop->xo_data; + + if (xbp->xb_curp != xbp->xb_bufp) { + xo_buf_append(xbp, "", 1); /* Append ending NUL */ + xo_anchor_clear(xop); + if (xop->xo_write) + rc = xop->xo_write(xop->xo_opaque, xbp->xb_bufp); + xbp->xb_curp = xbp->xb_bufp; + } + + /* Turn off the flags that don't survive across writes */ + XOIF_CLEAR(xop, XOIF_UNITS_PENDING); + + return rc; +} + +/* + * Format arguments into our buffer. If a custom formatter has been set, + * we use that to do the work; otherwise we vsnprintf(). + */ +static ssize_t +xo_vsnprintf (xo_handle_t *xop, xo_buffer_t *xbp, const char *fmt, va_list vap) +{ + va_list va_local; + ssize_t rc; + ssize_t left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + + va_copy(va_local, vap); + + if (xop->xo_formatter) + rc = xop->xo_formatter(xop, xbp->xb_curp, left, fmt, va_local); + else + rc = vsnprintf(xbp->xb_curp, left, fmt, va_local); + + if (rc >= left) { + if (!xo_buf_has_room(xbp, rc)) { + va_end(va_local); + return -1; + } + + /* + * After we call vsnprintf(), the stage of vap is not defined. + * We need to copy it before we pass. Then we have to do our + * own logic below to move it along. This is because the + * implementation can have va_list be a pointer (bsd) or a + * structure (macosx) or anything in between. + */ + + va_end(va_local); /* Reset vap to the start */ + va_copy(va_local, vap); + + left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + if (xop->xo_formatter) + rc = xop->xo_formatter(xop, xbp->xb_curp, left, fmt, va_local); + else + rc = vsnprintf(xbp->xb_curp, left, fmt, va_local); + } + va_end(va_local); + + return rc; +} + +/* + * Print some data through the handle. + */ +static ssize_t +xo_printf_v (xo_handle_t *xop, const char *fmt, va_list vap) +{ + xo_buffer_t *xbp = &xop->xo_data; + ssize_t left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + ssize_t rc; + va_list va_local; + + va_copy(va_local, vap); + + rc = vsnprintf(xbp->xb_curp, left, fmt, va_local); + + if (rc >= left) { + if (!xo_buf_has_room(xbp, rc)) { + va_end(va_local); + return -1; + } + + va_end(va_local); /* Reset vap to the start */ + va_copy(va_local, vap); + + left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + rc = vsnprintf(xbp->xb_curp, left, fmt, va_local); + } + + va_end(va_local); + + if (rc > 0) + xbp->xb_curp += rc; + + return rc; +} + +static ssize_t +xo_printf (xo_handle_t *xop, const char *fmt, ...) +{ + ssize_t rc; + va_list vap; + + va_start(vap, fmt); + + rc = xo_printf_v(xop, fmt, vap); + + va_end(vap); + return rc; +} + +/* + * These next few function are make The Essential UTF-8 Ginsu Knife. + * Identify an input and output character, and convert it. + */ +static uint8_t xo_utf8_data_bits[5] = { 0, 0x7f, 0x1f, 0x0f, 0x07 }; +static uint8_t xo_utf8_len_bits[5] = { 0, 0x00, 0xc0, 0xe0, 0xf0 }; + +/* + * If the byte has a high-bit set, it's UTF-8, not ASCII. + */ +static int +xo_is_utf8 (char ch) +{ + return (ch & 0x80); +} + +/* + * Look at the high bits of the first byte to determine the length + * of the UTF-8 character. + */ +static inline ssize_t +xo_utf8_to_wc_len (const char *buf) +{ + uint8_t bval = (uint8_t) *buf; + ssize_t len; + + if ((bval & 0x80) == 0x0) + len = 1; + else if ((bval & 0xe0) == 0xc0) + len = 2; + else if ((bval & 0xf0) == 0xe0) + len = 3; + else if ((bval & 0xf8) == 0xf0) + len = 4; + else + len = -1; + + return len; +} + +static ssize_t +xo_buf_utf8_len (xo_handle_t *xop, const char *buf, ssize_t bufsiz) +{ + unsigned b = (unsigned char) *buf; + ssize_t len, i; + + len = xo_utf8_to_wc_len(buf); + if (len < 0) { + xo_failure(xop, "invalid UTF-8 data: %02hhx", b); + return -1; + } + + if (len > bufsiz) { + xo_failure(xop, "invalid UTF-8 data (short): %02hhx (%d/%d)", + b, len, bufsiz); + return -1; + } + + for (i = 2; i < len; i++) { + b = (unsigned char ) buf[i]; + if ((b & 0xc0) != 0x80) { + xo_failure(xop, "invalid UTF-8 data (byte %d): %x", i, b); + return -1; + } + } + + return len; +} + +/* + * Build a wide character from the input buffer; the number of + * bits we pull off the first character is dependent on the length, + * but we put 6 bits off all other bytes. + */ +static inline wchar_t +xo_utf8_char (const char *buf, ssize_t len) +{ + /* Most common case: singleton byte */ + if (len == 1) + return (unsigned char) buf[0]; + + ssize_t i; + wchar_t wc; + const unsigned char *cp = (const unsigned char *) buf; + + wc = *cp & xo_utf8_data_bits[len]; + for (i = 1; i < len; i++) { + wc <<= 6; /* Low six bits have data */ + wc |= cp[i] & 0x3f; + if ((cp[i] & 0xc0) != 0x80) + return (wchar_t) -1; + } + + return wc; +} + +/* + * Determine the number of bytes needed to encode a wide character. + */ +static ssize_t +xo_utf8_emit_len (wchar_t wc) +{ + ssize_t len; + + if ((wc & ((1 << 7) - 1)) == wc) /* Simple case */ + len = 1; + else if ((wc & ((1 << 11) - 1)) == wc) + len = 2; + else if ((wc & ((1 << 16) - 1)) == wc) + len = 3; + else if ((wc & ((1 << 21) - 1)) == wc) + len = 4; + else + len = -1; /* Invalid */ + + return len; +} + +/* + * Emit one wide character into the given buffer + */ +static void +xo_utf8_emit_char (char *buf, ssize_t len, wchar_t wc) +{ + ssize_t i; + + if (len == 1) { /* Simple case */ + buf[0] = wc & 0x7f; + return; + } + + /* Start with the low bits and insert them, six bits at a time */ + for (i = len - 1; i >= 0; i--) { + buf[i] = 0x80 | (wc & 0x3f); + wc >>= 6; /* Drop the low six bits */ + } + + /* Finish off the first byte with the length bits */ + buf[0] &= xo_utf8_data_bits[len]; /* Clear out the length bits */ + buf[0] |= xo_utf8_len_bits[len]; /* Drop in new length bits */ +} + +/* + * Append a single UTF-8 character to a buffer, converting it to locale + * encoding. Returns the number of columns consumed by that character, + * as best we can determine it. + */ +static ssize_t +xo_buf_append_locale_from_utf8 (xo_handle_t *xop, xo_buffer_t *xbp, + const char *ibuf, ssize_t ilen) +{ + wchar_t wc; + ssize_t len; + + /* + * Build our wide character from the input buffer; the number of + * bits we pull off the first character is dependent on the length, + * but we put 6 bits off all other bytes. + */ + wc = xo_utf8_char(ibuf, ilen); + if (wc == (wchar_t) -1) { + xo_failure(xop, "invalid UTF-8 byte sequence"); + return 0; + } + + if (XOF_ISSET(xop, XOF_NO_LOCALE)) { + if (!xo_buf_has_room(xbp, ilen)) + return 0; + + memcpy(xbp->xb_curp, ibuf, ilen); + xbp->xb_curp += ilen; + + } else { + if (!xo_buf_has_room(xbp, MB_LEN_MAX + 1)) + return 0; + + bzero(&xop->xo_mbstate, sizeof(xop->xo_mbstate)); + len = wcrtomb(xbp->xb_curp, wc, &xop->xo_mbstate); + + if (len <= 0) { + xo_failure(xop, "could not convert wide char: %lx", + (unsigned long) wc); + return 0; + } + xbp->xb_curp += len; + } + + return xo_wcwidth(wc); +} + +/* + * Append a UTF-8 string to a buffer, converting it into locale encoding + */ +static void +xo_buf_append_locale (xo_handle_t *xop, xo_buffer_t *xbp, + const char *cp, ssize_t len) +{ + const char *sp = cp, *ep = cp + len; + ssize_t save_off = xbp->xb_bufp - xbp->xb_curp; + ssize_t slen; + int cols = 0; + + for ( ; cp < ep; cp++) { + if (!xo_is_utf8(*cp)) { + cols += 1; + continue; + } + + /* + * We're looking at a non-ascii UTF-8 character. + * First we copy the previous data. + * Then we need find the length and validate it. + * Then we turn it into a wide string. + * Then we turn it into a localized string. + * Then we repeat. Isn't i18n fun? + */ + if (sp != cp) + xo_buf_append(xbp, sp, cp - sp); /* Append previous data */ + + slen = xo_buf_utf8_len(xop, cp, ep - cp); + if (slen <= 0) { + /* Bad data; back it all out */ + xbp->xb_curp = xbp->xb_bufp + save_off; + return; + } + + cols += xo_buf_append_locale_from_utf8(xop, xbp, cp, slen); + + /* Next time through, we'll start at the next character */ + cp += slen - 1; + sp = cp + 1; + } + + /* Update column values */ + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += cols; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += cols; + + /* Before we fall into the basic logic below, we need reset len */ + len = ep - sp; + if (len != 0) /* Append trailing data */ + xo_buf_append(xbp, sp, len); +} + +/* + * Append the given string to the given buffer, without escaping or + * character set conversion. This is the straight copy to the data + * buffer with no fanciness. + */ +static void +xo_data_append (xo_handle_t *xop, const char *str, ssize_t len) +{ + xo_buf_append(&xop->xo_data, str, len); +} + +/* + * Append the given string to the given buffer + */ +static void +xo_data_escape (xo_handle_t *xop, const char *str, ssize_t len) +{ + xo_buf_escape(xop, &xop->xo_data, str, len, 0); +} + +#ifdef LIBXO_NO_RETAIN +/* + * Empty implementations of the retain logic + */ + +void +xo_retain_clear_all (void) +{ + return; +} + +void +xo_retain_clear (const char *fmt UNUSED) +{ + return; +} +static void +xo_retain_add (const char *fmt UNUSED, xo_field_info_t *fields UNUSED, + unsigned num_fields UNUSED) +{ + return; +} + +static int +xo_retain_find (const char *fmt UNUSED, xo_field_info_t **valp UNUSED, + unsigned *nump UNUSED) +{ + return -1; +} + +#else /* !LIBXO_NO_RETAIN */ +/* + * Retain: We retain parsed field definitions to enhance performance, + * especially inside loops. We depend on the caller treating the format + * strings as immutable, so that we can retain pointers into them. We + * hold the pointers in a hash table, so allow quick access. Retained + * information is retained until xo_retain_clear is called. + */ + +/* + * xo_retain_entry_t holds information about one retained set of + * parsed fields. + */ +typedef struct xo_retain_entry_s { + struct xo_retain_entry_s *xre_next; /* Pointer to next (older) entry */ + unsigned long xre_hits; /* Number of times we've hit */ + const char *xre_format; /* Pointer to format string */ + unsigned xre_num_fields; /* Number of fields saved */ + xo_field_info_t *xre_fields; /* Pointer to fields */ +} xo_retain_entry_t; + +/* + * xo_retain_t holds a complete set of parsed fields as a hash table. + */ +#ifndef XO_RETAIN_SIZE +#define XO_RETAIN_SIZE 6 +#endif /* XO_RETAIN_SIZE */ +#define RETAIN_HASH_SIZE (1<<XO_RETAIN_SIZE) + +typedef struct xo_retain_s { + xo_retain_entry_t *xr_bucket[RETAIN_HASH_SIZE]; +} xo_retain_t; + +static THREAD_LOCAL(xo_retain_t) xo_retain; +static THREAD_LOCAL(unsigned) xo_retain_count; + +/* + * Simple hash function based on Thomas Wang's paper. The original is + * gone, but an archive is available on the Way Back Machine: + * + * http://web.archive.org/web/20071223173210/\ + * http://www.concentric.net/~Ttwang/tech/inthash.htm + * + * For our purposes, we can assume the low four bits are uninteresting + * since any string less that 16 bytes wouldn't be worthy of + * retaining. We toss the high bits also, since these bits are likely + * to be common among constant format strings. We then run Wang's + * algorithm, and cap the result at RETAIN_HASH_SIZE. + */ +static unsigned +xo_retain_hash (const char *fmt) +{ + volatile uintptr_t iptr = (uintptr_t) (const void *) fmt; + + /* Discard low four bits and high bits; they aren't interesting */ + uint32_t val = (uint32_t) ((iptr >> 4) & (((1 << 24) - 1))); + + val = (val ^ 61) ^ (val >> 16); + val = val + (val << 3); + val = val ^ (val >> 4); + val = val * 0x3a8f05c5; /* My large prime number */ + val = val ^ (val >> 15); + val &= RETAIN_HASH_SIZE - 1; + + return val; +} + +/* + * Walk all buckets, clearing all retained entries + */ +void +xo_retain_clear_all (void) +{ + int i; + xo_retain_entry_t *xrep, *next; + + for (i = 0; i < RETAIN_HASH_SIZE; i++) { + for (xrep = xo_retain.xr_bucket[i]; xrep; xrep = next) { + next = xrep->xre_next; + xo_free(xrep); + } + xo_retain.xr_bucket[i] = NULL; + } + xo_retain_count = 0; +} + +/* + * Walk all buckets, clearing all retained entries + */ +void +xo_retain_clear (const char *fmt) +{ + xo_retain_entry_t **xrepp; + unsigned hash = xo_retain_hash(fmt); + + for (xrepp = &xo_retain.xr_bucket[hash]; *xrepp; + xrepp = &(*xrepp)->xre_next) { + if ((*xrepp)->xre_format == fmt) { + *xrepp = (*xrepp)->xre_next; + xo_retain_count -= 1; + return; + } + } +} + +/* + * Search the hash for an entry matching 'fmt'; return it's fields. + */ +static int +xo_retain_find (const char *fmt, xo_field_info_t **valp, unsigned *nump) +{ + if (xo_retain_count == 0) + return -1; + + unsigned hash = xo_retain_hash(fmt); + xo_retain_entry_t *xrep; + + for (xrep = xo_retain.xr_bucket[hash]; xrep != NULL; + xrep = xrep->xre_next) { + if (xrep->xre_format == fmt) { + *valp = xrep->xre_fields; + *nump = xrep->xre_num_fields; + xrep->xre_hits += 1; + return 0; + } + } + + return -1; +} + +static void +xo_retain_add (const char *fmt, xo_field_info_t *fields, unsigned num_fields) +{ + unsigned hash = xo_retain_hash(fmt); + xo_retain_entry_t *xrep; + ssize_t sz = sizeof(*xrep) + (num_fields + 1) * sizeof(*fields); + xo_field_info_t *xfip; + + xrep = xo_realloc(NULL, sz); + if (xrep == NULL) + return; + + xfip = (xo_field_info_t *) &xrep[1]; + memcpy(xfip, fields, num_fields * sizeof(*fields)); + + bzero(xrep, sizeof(*xrep)); + + xrep->xre_format = fmt; + xrep->xre_fields = xfip; + xrep->xre_num_fields = num_fields; + + /* Record the field info in the retain bucket */ + xrep->xre_next = xo_retain.xr_bucket[hash]; + xo_retain.xr_bucket[hash] = xrep; + xo_retain_count += 1; +} + +#endif /* !LIBXO_NO_RETAIN */ + +/* + * Generate a warning. Normally, this is a text message written to + * standard error. If the XOF_WARN_XML flag is set, then we generate + * XMLified content on standard output. + */ +static void +xo_warn_hcv (xo_handle_t *xop, int code, int check_warn, + const char *fmt, va_list vap) +{ + xop = xo_default(xop); + if (check_warn && !XOF_ISSET(xop, XOF_WARN)) + return; + + if (fmt == NULL) + return; + + ssize_t len = strlen(fmt); + ssize_t plen = xo_program ? strlen(xo_program) : 0; + char *newfmt = alloca(len + 1 + plen + 2); /* NUL, and ": " */ + + if (plen) { + memcpy(newfmt, xo_program, plen); + newfmt[plen++] = ':'; + newfmt[plen++] = ' '; + } + + memcpy(newfmt + plen, fmt, len); + newfmt[len + plen] = '\0'; + + if (XOF_ISSET(xop, XOF_WARN_XML)) { + static char err_open[] = "<error>"; + static char err_close[] = "</error>"; + static char msg_open[] = "<message>"; + static char msg_close[] = "</message>"; + + xo_buffer_t *xbp = &xop->xo_data; + + xo_buf_append(xbp, err_open, sizeof(err_open) - 1); + xo_buf_append(xbp, msg_open, sizeof(msg_open) - 1); + + va_list va_local; + va_copy(va_local, vap); + + ssize_t left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + ssize_t rc = vsnprintf(xbp->xb_curp, left, newfmt, vap); + + if (rc >= left) { + if (!xo_buf_has_room(xbp, rc)) { + va_end(va_local); + return; + } + + va_end(vap); /* Reset vap to the start */ + va_copy(vap, va_local); + + left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + rc = vsnprintf(xbp->xb_curp, left, fmt, vap); + } + + va_end(va_local); + + rc = xo_escape_xml(xbp, rc, 1); + xbp->xb_curp += rc; + + xo_buf_append(xbp, msg_close, sizeof(msg_close) - 1); + xo_buf_append(xbp, err_close, sizeof(err_close) - 1); + + if (code >= 0) { + const char *msg = strerror(code); + + if (msg) { + xo_buf_append(xbp, ": ", 2); + xo_buf_append(xbp, msg, strlen(msg)); + } + } + + xo_buf_append(xbp, "\n", 1); /* Append newline and NUL to string */ + (void) xo_write(xop); + + } else { + vfprintf(stderr, newfmt, vap); + if (code >= 0) { + const char *msg = strerror(code); + + if (msg) + fprintf(stderr, ": %s", msg); + } + fprintf(stderr, "\n"); + } +} + +void +xo_warn_hc (xo_handle_t *xop, int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(xop, code, 0, fmt, vap); + va_end(vap); +} + +void +xo_warn_c (int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(NULL, code, 0, fmt, vap); + va_end(vap); +} + +void +xo_warn (const char *fmt, ...) +{ + int code = errno; + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(NULL, code, 0, fmt, vap); + va_end(vap); +} + +void +xo_warnx (const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(NULL, -1, 0, fmt, vap); + va_end(vap); +} + +void +xo_err (int eval, const char *fmt, ...) +{ + int code = errno; + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(NULL, code, 0, fmt, vap); + va_end(vap); + xo_finish(); + exit(eval); +} + +void +xo_errx (int eval, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(NULL, -1, 0, fmt, vap); + va_end(vap); + xo_finish(); + exit(eval); +} + +void +xo_errc (int eval, int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(NULL, code, 0, fmt, vap); + va_end(vap); + xo_finish(); + exit(eval); +} + +/* + * Generate a warning. Normally, this is a text message written to + * standard error. If the XOF_WARN_XML flag is set, then we generate + * XMLified content on standard output. + */ +void +xo_message_hcv (xo_handle_t *xop, int code, const char *fmt, va_list vap) +{ + static char msg_open[] = "<message>"; + static char msg_close[] = "</message>"; + xo_buffer_t *xbp; + ssize_t rc; + va_list va_local; + + xop = xo_default(xop); + + if (fmt == NULL || *fmt == '\0') + return; + + int need_nl = (fmt[strlen(fmt) - 1] != '\n'); + + switch (xo_style(xop)) { + case XO_STYLE_XML: + xbp = &xop->xo_data; + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_buf_indent(xop, xop->xo_indent_by); + xo_buf_append(xbp, msg_open, sizeof(msg_open) - 1); + + va_copy(va_local, vap); + + ssize_t left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + + rc = vsnprintf(xbp->xb_curp, left, fmt, vap); + if (rc >= left) { + if (!xo_buf_has_room(xbp, rc)) { + va_end(va_local); + return; + } + + va_end(vap); /* Reset vap to the start */ + va_copy(vap, va_local); + + left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + rc = vsnprintf(xbp->xb_curp, left, fmt, vap); + } + + va_end(va_local); + + rc = xo_escape_xml(xbp, rc, 0); + xbp->xb_curp += rc; + + if (need_nl && code > 0) { + const char *msg = strerror(code); + + if (msg) { + xo_buf_append(xbp, ": ", 2); + xo_buf_append(xbp, msg, strlen(msg)); + } + } + + if (need_nl) + xo_buf_append(xbp, "\n", 1); /* Append newline and NUL to string */ + + xo_buf_append(xbp, msg_close, sizeof(msg_close) - 1); + + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_buf_append(xbp, "\n", 1); /* Append newline and NUL to string */ + + (void) xo_write(xop); + break; + + case XO_STYLE_HTML: + { + char buf[BUFSIZ], *bp = buf, *cp; + ssize_t bufsiz = sizeof(buf); + ssize_t rc2; + + va_copy(va_local, vap); + + rc = vsnprintf(bp, bufsiz, fmt, va_local); + if (rc > bufsiz) { + bufsiz = rc + BUFSIZ; + bp = alloca(bufsiz); + va_end(va_local); + va_copy(va_local, vap); + rc = vsnprintf(bp, bufsiz, fmt, va_local); + } + + va_end(va_local); + cp = bp + rc; + + if (need_nl) { + rc2 = snprintf(cp, bufsiz - rc, "%s%s\n", + (code > 0) ? ": " : "", + (code > 0) ? strerror(code) : ""); + if (rc2 > 0) + rc += rc2; + } + + xo_buf_append_div(xop, "message", 0, NULL, 0, bp, rc, + NULL, 0, NULL, 0); + } + break; + + case XO_STYLE_JSON: + case XO_STYLE_SDPARAMS: + case XO_STYLE_ENCODER: + /* No means of representing messages */ + return; + + case XO_STYLE_TEXT: + rc = xo_printf_v(xop, fmt, vap); + /* + * XXX need to handle UTF-8 widths + */ + if (rc > 0) { + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += rc; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += rc; + } + + if (need_nl && code > 0) { + const char *msg = strerror(code); + + if (msg) { + xo_printf(xop, ": %s", msg); + } + } + if (need_nl) + xo_printf(xop, "\n"); + + break; + } + + switch (xo_style(xop)) { + case XO_STYLE_HTML: + if (XOIF_ISSET(xop, XOIF_DIV_OPEN)) { + static char div_close[] = "</div>"; + + XOIF_CLEAR(xop, XOIF_DIV_OPEN); + xo_data_append(xop, div_close, sizeof(div_close) - 1); + + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_data_append(xop, "\n", 1); + } + break; + } + + (void) xo_flush_h(xop); +} + +void +xo_message_hc (xo_handle_t *xop, int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_message_hcv(xop, code, fmt, vap); + va_end(vap); +} + +void +xo_message_c (int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_message_hcv(NULL, code, fmt, vap); + va_end(vap); +} + +void +xo_message_e (const char *fmt, ...) +{ + int code = errno; + va_list vap; + + va_start(vap, fmt); + xo_message_hcv(NULL, code, fmt, vap); + va_end(vap); +} + +void +xo_message (const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_message_hcv(NULL, 0, fmt, vap); + va_end(vap); +} + +void +xo_failure (xo_handle_t *xop, const char *fmt, ...) +{ + if (!XOF_ISSET(xop, XOF_WARN)) + return; + + va_list vap; + + va_start(vap, fmt); + xo_warn_hcv(xop, -1, 1, fmt, vap); + va_end(vap); +} + +/** + * Create a handle for use by later libxo functions. + * + * Note: normal use of libxo does not require a distinct handle, since + * the default handle (used when NULL is passed) generates text on stdout. + * + * @param style Style of output desired (XO_STYLE_* value) + * @param flags Set of XOF_* flags in use with this handle + * @return Newly allocated handle + * @see xo_destroy + */ +xo_handle_t * +xo_create (xo_style_t style, xo_xof_flags_t flags) +{ + xo_handle_t *xop = xo_realloc(NULL, sizeof(*xop)); + + if (xop) { + bzero(xop, sizeof(*xop)); + + xop->xo_style = style; + XOF_SET(xop, flags); + xo_init_handle(xop); + xop->xo_style = style; /* Reset style (see LIBXO_OPTIONS) */ + } + + return xop; +} + +/** + * Create a handle that will write to the given file. Use + * the XOF_CLOSE_FP flag to have the file closed on xo_destroy(). + * + * @param fp FILE pointer to use + * @param style Style of output desired (XO_STYLE_* value) + * @param flags Set of XOF_* flags to use with this handle + * @return Newly allocated handle + * @see xo_destroy + */ +xo_handle_t * +xo_create_to_file (FILE *fp, xo_style_t style, xo_xof_flags_t flags) +{ + xo_handle_t *xop = xo_create(style, flags); + + if (xop) { + xop->xo_opaque = fp; + xop->xo_write = xo_write_to_file; + xop->xo_close = xo_close_file; + xop->xo_flush = xo_flush_file; + } + + return xop; +} + +/** + * Set the default handler to output to a file. + * + * @param xop libxo handle + * @param fp FILE pointer to use + * @return 0 on success, non-zero on failure + */ +int +xo_set_file_h (xo_handle_t *xop, FILE *fp) +{ + xop = xo_default(xop); + + if (fp == NULL) { + xo_failure(xop, "xo_set_file: NULL fp"); + return -1; + } + + xop->xo_opaque = fp; + xop->xo_write = xo_write_to_file; + xop->xo_close = xo_close_file; + xop->xo_flush = xo_flush_file; + + return 0; +} + +/** + * Set the default handler to output to a file. + * + * @param fp FILE pointer to use + * @return 0 on success, non-zero on failure + */ +int +xo_set_file (FILE *fp) +{ + return xo_set_file_h(NULL, fp); +} + +/** + * Release any resources held by the handle. + * + * @param xop XO handle to alter (or NULL for default handle) + */ +void +xo_destroy (xo_handle_t *xop_arg) +{ + xo_handle_t *xop = xo_default(xop_arg); + + xo_flush_h(xop); + + if (xop->xo_close && XOF_ISSET(xop, XOF_CLOSE_FP)) + xop->xo_close(xop->xo_opaque); + + xo_free(xop->xo_stack); + xo_buf_cleanup(&xop->xo_data); + xo_buf_cleanup(&xop->xo_fmt); + xo_buf_cleanup(&xop->xo_predicate); + xo_buf_cleanup(&xop->xo_attrs); + xo_buf_cleanup(&xop->xo_color_buf); + + if (xop->xo_version) + xo_free(xop->xo_version); + + if (xop_arg == NULL) { + bzero(&xo_default_handle, sizeof(xo_default_handle)); + xo_default_inited = 0; + } else + xo_free(xop); +} + +/** + * Record a new output style to use for the given handle (or default if + * handle is NULL). This output style will be used for any future output. + * + * @param xop XO handle to alter (or NULL for default handle) + * @param style new output style (XO_STYLE_*) + */ +void +xo_set_style (xo_handle_t *xop, xo_style_t style) +{ + xop = xo_default(xop); + xop->xo_style = style; +} + +/** + * Return the current style of a handle + * + * @param xop XO handle to access + * @return The handle's current style + */ +xo_style_t +xo_get_style (xo_handle_t *xop) +{ + xop = xo_default(xop); + return xo_style(xop); +} + +/** + * Return the XO_STYLE_* value matching a given name + * + * @param name String name of a style + * @return XO_STYLE_* value + */ +static int +xo_name_to_style (const char *name) +{ + if (xo_streq(name, "xml")) + return XO_STYLE_XML; + else if (xo_streq(name, "json")) + return XO_STYLE_JSON; + else if (xo_streq(name, "encoder")) + return XO_STYLE_ENCODER; + else if (xo_streq(name, "text")) + return XO_STYLE_TEXT; + else if (xo_streq(name, "html")) + return XO_STYLE_HTML; + else if (xo_streq(name, "sdparams")) + return XO_STYLE_SDPARAMS; + + return -1; +} + +/* + * Indicate if the style is an "encoding" one as opposed to a "display" one. + */ +static int +xo_style_is_encoding (xo_handle_t *xop) +{ + if (xo_style(xop) == XO_STYLE_JSON + || xo_style(xop) == XO_STYLE_XML + || xo_style(xop) == XO_STYLE_SDPARAMS + || xo_style(xop) == XO_STYLE_ENCODER) + return 1; + return 0; +} + +/* Simple name-value mapping */ +typedef struct xo_mapping_s { + xo_xff_flags_t xm_value; /* Flag value */ + const char *xm_name; /* String name */ +} xo_mapping_t; + +static xo_xff_flags_t +xo_name_lookup (xo_mapping_t *map, const char *value, ssize_t len) +{ + if (len == 0) + return 0; + + if (len < 0) + len = strlen(value); + + while (isspace((int) *value)) { + value += 1; + len -= 1; + } + + while (isspace((int) value[len])) + len -= 1; + + if (*value == '\0') + return 0; + + for ( ; map->xm_name; map++) + if (strncmp(map->xm_name, value, len) == 0) + return map->xm_value; + + return 0; +} + +#ifdef NOT_NEEDED_YET +static const char * +xo_value_lookup (xo_mapping_t *map, xo_xff_flags_t value) +{ + if (value == 0) + return NULL; + + for ( ; map->xm_name; map++) + if (map->xm_value == value) + return map->xm_name; + + return NULL; +} +#endif /* NOT_NEEDED_YET */ + +static xo_mapping_t xo_xof_names[] = { + { XOF_COLOR_ALLOWED, "color" }, + { XOF_COLOR, "color-force" }, + { XOF_COLUMNS, "columns" }, + { XOF_DTRT, "dtrt" }, + { XOF_FLUSH, "flush" }, + { XOF_FLUSH_LINE, "flush-line" }, + { XOF_IGNORE_CLOSE, "ignore-close" }, + { XOF_INFO, "info" }, + { XOF_KEYS, "keys" }, + { XOF_LOG_GETTEXT, "log-gettext" }, + { XOF_LOG_SYSLOG, "log-syslog" }, + { XOF_NO_HUMANIZE, "no-humanize" }, + { XOF_NO_LOCALE, "no-locale" }, + { XOF_RETAIN_NONE, "no-retain" }, + { XOF_NO_TOP, "no-top" }, + { XOF_NOT_FIRST, "not-first" }, + { XOF_PRETTY, "pretty" }, + { XOF_RETAIN_ALL, "retain" }, + { XOF_UNDERSCORES, "underscores" }, + { XOF_UNITS, "units" }, + { XOF_WARN, "warn" }, + { XOF_WARN_XML, "warn-xml" }, + { XOF_XPATH, "xpath" }, + { 0, NULL } +}; + +/* Options available via the environment variable ($LIBXO_OPTIONS) */ +static xo_mapping_t xo_xof_simple_names[] = { + { XOF_COLOR_ALLOWED, "color" }, + { XOF_FLUSH, "flush" }, + { XOF_FLUSH_LINE, "flush-line" }, + { XOF_NO_HUMANIZE, "no-humanize" }, + { XOF_NO_LOCALE, "no-locale" }, + { XOF_RETAIN_NONE, "no-retain" }, + { XOF_PRETTY, "pretty" }, + { XOF_RETAIN_ALL, "retain" }, + { XOF_UNDERSCORES, "underscores" }, + { XOF_WARN, "warn" }, + { 0, NULL } +}; + +/* + * Convert string name to XOF_* flag value. + * Not all are useful. Or safe. Or sane. + */ +static unsigned +xo_name_to_flag (const char *name) +{ + return (unsigned) xo_name_lookup(xo_xof_names, name, -1); +} + +/** + * Set the style of an libxo handle based on a string name + * + * @param xop XO handle + * @param name String value of name + * @return 0 on success, non-zero on failure + */ +int +xo_set_style_name (xo_handle_t *xop, const char *name) +{ + if (name == NULL) + return -1; + + int style = xo_name_to_style(name); + + if (style < 0) + return -1; + + xo_set_style(xop, style); + return 0; +} + +/* + * Fill in the color map, based on the input string; currently unimplemented + * Look for something like "colors=red/blue+green/yellow" as fg/bg pairs. + */ +static void +xo_set_color_map (xo_handle_t *xop, char *value) +{ + if (xo_text_only()) + return; + + char *cp, *ep, *vp, *np; + ssize_t len = value ? strlen(value) + 1 : 0; + int num = 1, fg, bg; + + for (cp = value, ep = cp + len - 1; cp && *cp && cp < ep; cp = np) { + np = strchr(cp, '+'); + if (np) + *np++ = '\0'; + + vp = strchr(cp, '/'); + if (vp) + *vp++ = '\0'; + + fg = *cp ? xo_color_find(cp) : -1; + bg = (vp && *vp) ? xo_color_find(vp) : -1; + +#ifndef LIBXO_TEXT_ONLY + xop->xo_color_map_fg[num] = (fg < 0) ? num : fg; + xop->xo_color_map_bg[num] = (bg < 0) ? num : bg; +#endif /* LIBXO_TEXT_ONLY */ + + if (++num > XO_NUM_COLORS) + break; + } + + /* If no color initialization happened, then we don't need the map */ + if (num > 1) + XOF_SET(xop, XOF_COLOR_MAP); + else + XOF_CLEAR(xop, XOF_COLOR_MAP); + +#ifndef LIBXO_TEXT_ONLY + /* Fill in the rest of the colors with the defaults */ + for ( ; num < XO_NUM_COLORS; num++) + xop->xo_color_map_fg[num] = xop->xo_color_map_bg[num] = num; +#endif /* LIBXO_TEXT_ONLY */ +} + +static int +xo_set_options_simple (xo_handle_t *xop, const char *input) +{ + xo_xof_flags_t new_flag; + char *cp, *ep, *vp, *np, *bp; + ssize_t len = strlen(input) + 1; + + bp = alloca(len); + memcpy(bp, input, len); + + for (cp = bp, ep = cp + len - 1; cp && cp < ep; cp = np) { + np = strchr(cp, ','); + if (np) + *np++ = '\0'; + + vp = strchr(cp, '='); + if (vp) + *vp++ = '\0'; + + if (xo_streq("colors", cp)) { + xo_set_color_map(xop, vp); + continue; + } + + new_flag = xo_name_lookup(xo_xof_simple_names, cp, -1); + if (new_flag != 0) { + XOF_SET(xop, new_flag); + } else if (xo_streq(cp, "no-color")) { + XOF_CLEAR(xop, XOF_COLOR_ALLOWED); + } else { + xo_failure(xop, "unknown simple option: %s", cp); + return -1; + } + } + + return 0; +} + +/** + * Set the options for a handle using a string of options + * passed in. The input is a comma-separated set of names + * and optional values: "xml,pretty,indent=4" + * + * @param xop XO handle + * @param input Comma-separated set of option values + * @return 0 on success, non-zero on failure + */ +int +xo_set_options (xo_handle_t *xop, const char *input) +{ + char *cp, *ep, *vp, *np, *bp; + int style = -1, new_style, rc = 0; + ssize_t len; + xo_xof_flags_t new_flag; + + if (input == NULL) + return 0; + + xop = xo_default(xop); + +#ifdef LIBXO_COLOR_ON_BY_DEFAULT + /* If the installer used --enable-color-on-by-default, then we allow it */ + XOF_SET(xop, XOF_COLOR_ALLOWED); +#endif /* LIBXO_COLOR_ON_BY_DEFAULT */ + + /* + * We support a simpler, old-school style of giving option + * also, using a single character for each option. It's + * ideal for lazy people, such as myself. + */ + if (*input == ':') { + ssize_t sz; + + for (input++ ; *input; input++) { + switch (*input) { + case 'c': + XOF_SET(xop, XOF_COLOR_ALLOWED); + break; + + case 'f': + XOF_SET(xop, XOF_FLUSH); + break; + + case 'F': + XOF_SET(xop, XOF_FLUSH_LINE); + break; + + case 'g': + XOF_SET(xop, XOF_LOG_GETTEXT); + break; + + case 'H': + xop->xo_style = XO_STYLE_HTML; + break; + + case 'I': + XOF_SET(xop, XOF_INFO); + break; + + case 'i': + sz = strspn(input + 1, "0123456789"); + if (sz > 0) { + xop->xo_indent_by = atoi(input + 1); + input += sz - 1; /* Skip value */ + } + break; + + case 'J': + xop->xo_style = XO_STYLE_JSON; + break; + + case 'k': + XOF_SET(xop, XOF_KEYS); + break; + + case 'n': + XOF_SET(xop, XOF_NO_HUMANIZE); + break; + + case 'P': + XOF_SET(xop, XOF_PRETTY); + break; + + case 'T': + xop->xo_style = XO_STYLE_TEXT; + break; + + case 'U': + XOF_SET(xop, XOF_UNITS); + break; + + case 'u': + XOF_SET(xop, XOF_UNDERSCORES); + break; + + case 'W': + XOF_SET(xop, XOF_WARN); + break; + + case 'X': + xop->xo_style = XO_STYLE_XML; + break; + + case 'x': + XOF_SET(xop, XOF_XPATH); + break; + } + } + return 0; + } + + len = strlen(input) + 1; + bp = alloca(len); + memcpy(bp, input, len); + + for (cp = bp, ep = cp + len - 1; cp && cp < ep; cp = np) { + np = strchr(cp, ','); + if (np) + *np++ = '\0'; + + /* + * "@foo" is a shorthand for "encoder=foo". This is driven + * chiefly by a desire to make pluggable encoders not appear + * so distinct from built-in encoders. + */ + if (*cp == '@') { + vp = cp + 1; + + if (*vp == '\0') + xo_failure(xop, "missing value for encoder option"); + else { + rc = xo_encoder_init(xop, vp); + if (rc) + xo_warnx("error initializing encoder: %s", vp); + } + + continue; + } + + vp = strchr(cp, '='); + if (vp) + *vp++ = '\0'; + + if (xo_streq("colors", cp)) { + xo_set_color_map(xop, vp); + continue; + } + + /* + * For options, we don't allow "encoder" since we want to + * handle it explicitly below as "encoder=xxx". + */ + new_style = xo_name_to_style(cp); + if (new_style >= 0 && new_style != XO_STYLE_ENCODER) { + if (style >= 0) + xo_warnx("ignoring multiple styles: '%s'", cp); + else + style = new_style; + } else { + new_flag = xo_name_to_flag(cp); + if (new_flag != 0) + XOF_SET(xop, new_flag); + else if (xo_streq(cp, "no-color")) + XOF_CLEAR(xop, XOF_COLOR_ALLOWED); + else if (xo_streq(cp, "indent")) { + if (vp) + xop->xo_indent_by = atoi(vp); + else + xo_failure(xop, "missing value for indent option"); + } else if (xo_streq(cp, "encoder")) { + if (vp == NULL) + xo_failure(xop, "missing value for encoder option"); + else { + rc = xo_encoder_init(xop, vp); + if (rc) + xo_warnx("error initializing encoder: %s", vp); + } + + } else { + xo_warnx("unknown libxo option value: '%s'", cp); + rc = -1; + } + } + } + + if (style > 0) + xop->xo_style= style; + + return rc; +} + +/** + * Set one or more flags for a given handle (or default if handle is NULL). + * These flags will affect future output. + * + * @param xop XO handle to alter (or NULL for default handle) + * @param flags Flags to be set (XOF_*) + */ +void +xo_set_flags (xo_handle_t *xop, xo_xof_flags_t flags) +{ + xop = xo_default(xop); + + XOF_SET(xop, flags); +} + +/** + * Accessor to return the current set of flags for a handle + * @param xop XO handle + * @return Current set of flags + */ +xo_xof_flags_t +xo_get_flags (xo_handle_t *xop) +{ + xop = xo_default(xop); + + return xop->xo_flags; +} + +/** + * strndup with a twist: len < 0 means len = strlen(str) + */ +static char * +xo_strndup (const char *str, ssize_t len) +{ + if (len < 0) + len = strlen(str); + + char *cp = xo_realloc(NULL, len + 1); + if (cp) { + memcpy(cp, str, len); + cp[len] = '\0'; + } + + return cp; +} + +/** + * Record a leading prefix for the XPath we generate. This allows the + * generated data to be placed within an XML hierarchy but still have + * accurate XPath expressions. + * + * @param xop XO handle to alter (or NULL for default handle) + * @param path The XPath expression + */ +void +xo_set_leading_xpath (xo_handle_t *xop, const char *path) +{ + xop = xo_default(xop); + + if (xop->xo_leading_xpath) { + xo_free(xop->xo_leading_xpath); + xop->xo_leading_xpath = NULL; + } + + if (path == NULL) + return; + + xop->xo_leading_xpath = xo_strndup(path, -1); +} + +/** + * Record the info data for a set of tags + * + * @param xop XO handle to alter (or NULL for default handle) + * @param info Info data (xo_info_t) to be recorded (or NULL) (MUST BE SORTED) + * @pararm count Number of entries in info (or -1 to count them ourselves) + */ +void +xo_set_info (xo_handle_t *xop, xo_info_t *infop, int count) +{ + xop = xo_default(xop); + + if (count < 0 && infop) { + xo_info_t *xip; + + for (xip = infop, count = 0; xip->xi_name; xip++, count++) + continue; + } + + xop->xo_info = infop; + xop->xo_info_count = count; +} + +/** + * Set the formatter callback for a handle. The callback should + * return a newly formatting contents of a formatting instruction, + * meaning the bits inside the braces. + */ +void +xo_set_formatter (xo_handle_t *xop, xo_formatter_t func, + xo_checkpointer_t cfunc) +{ + xop = xo_default(xop); + + xop->xo_formatter = func; + xop->xo_checkpointer = cfunc; +} + +/** + * Clear one or more flags for a given handle (or default if handle is NULL). + * These flags will affect future output. + * + * @param xop XO handle to alter (or NULL for default handle) + * @param flags Flags to be cleared (XOF_*) + */ +void +xo_clear_flags (xo_handle_t *xop, xo_xof_flags_t flags) +{ + xop = xo_default(xop); + + XOF_CLEAR(xop, flags); +} + +static const char * +xo_state_name (xo_state_t state) +{ + static const char *names[] = { + "init", + "open_container", + "close_container", + "open_list", + "close_list", + "open_instance", + "close_instance", + "open_leaf_list", + "close_leaf_list", + "discarding", + "marker", + "emit", + "emit_leaf_list", + "finish", + NULL + }; + + if (state < (sizeof(names) / sizeof(names[0]))) + return names[state]; + + return "unknown"; +} + +static void +xo_line_ensure_open (xo_handle_t *xop, xo_xff_flags_t flags UNUSED) +{ + static char div_open[] = "<div class=\"line\">"; + static char div_open_blank[] = "<div class=\"blank-line\">"; + + if (XOF_ISSET(xop, XOF_CONTINUATION)) { + XOF_CLEAR(xop, XOF_CONTINUATION); + XOIF_SET(xop, XOIF_DIV_OPEN); + return; + } + + if (XOIF_ISSET(xop, XOIF_DIV_OPEN)) + return; + + if (xo_style(xop) != XO_STYLE_HTML) + return; + + XOIF_SET(xop, XOIF_DIV_OPEN); + if (flags & XFF_BLANK_LINE) + xo_data_append(xop, div_open_blank, sizeof(div_open_blank) - 1); + else + xo_data_append(xop, div_open, sizeof(div_open) - 1); + + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_data_append(xop, "\n", 1); +} + +static void +xo_line_close (xo_handle_t *xop) +{ + static char div_close[] = "</div>"; + + switch (xo_style(xop)) { + case XO_STYLE_HTML: + if (!XOIF_ISSET(xop, XOIF_DIV_OPEN)) + xo_line_ensure_open(xop, 0); + + XOIF_CLEAR(xop, XOIF_DIV_OPEN); + xo_data_append(xop, div_close, sizeof(div_close) - 1); + + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_data_append(xop, "\n", 1); + break; + + case XO_STYLE_TEXT: + xo_data_append(xop, "\n", 1); + break; + } +} + +static int +xo_info_compare (const void *key, const void *data) +{ + const char *name = key; + const xo_info_t *xip = data; + + return strcmp(name, xip->xi_name); +} + + +static xo_info_t * +xo_info_find (xo_handle_t *xop, const char *name, ssize_t nlen) +{ + xo_info_t *xip; + char *cp = alloca(nlen + 1); /* Need local copy for NUL termination */ + + memcpy(cp, name, nlen); + cp[nlen] = '\0'; + + xip = bsearch(cp, xop->xo_info, xop->xo_info_count, + sizeof(xop->xo_info[0]), xo_info_compare); + return xip; +} + +#define CONVERT(_have, _need) (((_have) << 8) | (_need)) + +/* + * Check to see that the conversion is safe and sane. + */ +static int +xo_check_conversion (xo_handle_t *xop, int have_enc, int need_enc) +{ + switch (CONVERT(have_enc, need_enc)) { + case CONVERT(XF_ENC_UTF8, XF_ENC_UTF8): + case CONVERT(XF_ENC_UTF8, XF_ENC_LOCALE): + case CONVERT(XF_ENC_WIDE, XF_ENC_UTF8): + case CONVERT(XF_ENC_WIDE, XF_ENC_LOCALE): + case CONVERT(XF_ENC_LOCALE, XF_ENC_LOCALE): + case CONVERT(XF_ENC_LOCALE, XF_ENC_UTF8): + return 0; + + default: + xo_failure(xop, "invalid conversion (%c:%c)", have_enc, need_enc); + return 1; + } +} + +static int +xo_format_string_direct (xo_handle_t *xop, xo_buffer_t *xbp, + xo_xff_flags_t flags, + const wchar_t *wcp, const char *cp, + ssize_t len, int max, + int need_enc, int have_enc) +{ + int cols = 0; + wchar_t wc = 0; + ssize_t ilen, olen; + ssize_t width; + int attr = XOF_BIT_ISSET(flags, XFF_ATTR); + const char *sp; + + if (len > 0 && !xo_buf_has_room(xbp, len)) + return 0; + + for (;;) { + if (len == 0) + break; + + if (cp) { + if (*cp == '\0') + break; + if ((flags & XFF_UNESCAPE) && (*cp == '\\' || *cp == '%')) { + cp += 1; + len -= 1; + if (len == 0 || *cp == '\0') + break; + } + } + + if (wcp && *wcp == L'\0') + break; + + ilen = 0; + + switch (have_enc) { + case XF_ENC_WIDE: /* Wide character */ + wc = *wcp++; + ilen = 1; + break; + + case XF_ENC_UTF8: /* UTF-8 */ + ilen = xo_utf8_to_wc_len(cp); + if (ilen < 0) { + xo_failure(xop, "invalid UTF-8 character: %02hhx", *cp); + return -1; /* Can't continue; we can't find the end */ + } + + if (len > 0 && len < ilen) { + len = 0; /* Break out of the loop */ + continue; + } + + wc = xo_utf8_char(cp, ilen); + if (wc == (wchar_t) -1) { + xo_failure(xop, "invalid UTF-8 character: %02hhx/%d", + *cp, ilen); + return -1; /* Can't continue; we can't find the end */ + } + cp += ilen; + break; + + case XF_ENC_LOCALE: /* Native locale */ + ilen = (len > 0) ? len : MB_LEN_MAX; + ilen = mbrtowc(&wc, cp, ilen, &xop->xo_mbstate); + if (ilen < 0) { /* Invalid data; skip */ + xo_failure(xop, "invalid mbs char: %02hhx", *cp); + wc = L'?'; + ilen = 1; + } + + if (ilen == 0) { /* Hit a wide NUL character */ + len = 0; + continue; + } + + cp += ilen; + break; + } + + /* Reduce len, but not below zero */ + if (len > 0) { + len -= ilen; + if (len < 0) + len = 0; + } + + /* + * Find the width-in-columns of this character, which must be done + * in wide characters, since we lack a mbswidth() function. If + * it doesn't fit + */ + width = xo_wcwidth(wc); + if (width < 0) + width = iswcntrl(wc) ? 0 : 1; + + if (xo_style(xop) == XO_STYLE_TEXT || xo_style(xop) == XO_STYLE_HTML) { + if (max > 0 && cols + width > max) + break; + } + + switch (need_enc) { + case XF_ENC_UTF8: + + /* Output in UTF-8 needs to be escaped, based on the style */ + switch (xo_style(xop)) { + case XO_STYLE_XML: + case XO_STYLE_HTML: + if (wc == '<') + sp = xo_xml_lt; + else if (wc == '>') + sp = xo_xml_gt; + else if (wc == '&') + sp = xo_xml_amp; + else if (attr && wc == '"') + sp = xo_xml_quot; + else + break; + + ssize_t slen = strlen(sp); + if (!xo_buf_has_room(xbp, slen - 1)) + return -1; + + memcpy(xbp->xb_curp, sp, slen); + xbp->xb_curp += slen; + goto done_with_encoding; /* Need multi-level 'break' */ + + case XO_STYLE_JSON: + if (wc != '\\' && wc != '"' && wc != '\n' && wc != '\r') + break; + + if (!xo_buf_has_room(xbp, 2)) + return -1; + + *xbp->xb_curp++ = '\\'; + if (wc == '\n') + wc = 'n'; + else if (wc == '\r') + wc = 'r'; + else wc = wc & 0x7f; + + *xbp->xb_curp++ = wc; + goto done_with_encoding; + + case XO_STYLE_SDPARAMS: + if (wc != '\\' && wc != '"' && wc != ']') + break; + + if (!xo_buf_has_room(xbp, 2)) + return -1; + + *xbp->xb_curp++ = '\\'; + wc = wc & 0x7f; + *xbp->xb_curp++ = wc; + goto done_with_encoding; + } + + olen = xo_utf8_emit_len(wc); + if (olen < 0) { + xo_failure(xop, "ignoring bad length"); + continue; + } + + if (!xo_buf_has_room(xbp, olen)) + return -1; + + xo_utf8_emit_char(xbp->xb_curp, olen, wc); + xbp->xb_curp += olen; + break; + + case XF_ENC_LOCALE: + if (!xo_buf_has_room(xbp, MB_LEN_MAX + 1)) + return -1; + + olen = wcrtomb(xbp->xb_curp, wc, &xop->xo_mbstate); + if (olen <= 0) { + xo_failure(xop, "could not convert wide char: %lx", + (unsigned long) wc); + width = 1; + *xbp->xb_curp++ = '?'; + } else + xbp->xb_curp += olen; + break; + } + + done_with_encoding: + cols += width; + } + + return cols; +} + +static int +xo_needed_encoding (xo_handle_t *xop) +{ + if (XOF_ISSET(xop, XOF_UTF8)) /* Check the override flag */ + return XF_ENC_UTF8; + + if (xo_style(xop) == XO_STYLE_TEXT) /* Text means locale */ + return XF_ENC_LOCALE; + + return XF_ENC_UTF8; /* Otherwise, we love UTF-8 */ +} + +static ssize_t +xo_format_string (xo_handle_t *xop, xo_buffer_t *xbp, xo_xff_flags_t flags, + xo_format_t *xfp) +{ + static char null[] = "(null)"; + static char null_no_quotes[] = "null"; + + char *cp = NULL; + wchar_t *wcp = NULL; + ssize_t len; + ssize_t cols = 0, rc = 0; + ssize_t off = xbp->xb_curp - xbp->xb_bufp, off2; + int need_enc = xo_needed_encoding(xop); + + if (xo_check_conversion(xop, xfp->xf_enc, need_enc)) + return 0; + + len = xfp->xf_width[XF_WIDTH_SIZE]; + + if (xfp->xf_fc == 'm') { + cp = strerror(xop->xo_errno); + if (len < 0) + len = cp ? strlen(cp) : 0; + goto normal_string; + + } else if (xfp->xf_enc == XF_ENC_WIDE) { + wcp = va_arg(xop->xo_vap, wchar_t *); + if (xfp->xf_skip) + return 0; + + /* + * Dont' deref NULL; use the traditional "(null)" instead + * of the more accurate "who's been a naughty boy, then?". + */ + if (wcp == NULL) { + cp = null; + len = sizeof(null) - 1; + } + + } else { + cp = va_arg(xop->xo_vap, char *); /* UTF-8 or native */ + + normal_string: + if (xfp->xf_skip) + return 0; + + /* Echo "Dont' deref NULL" logic */ + if (cp == NULL) { + if ((flags & XFF_NOQUOTE) && xo_style_is_encoding(xop)) { + cp = null_no_quotes; + len = sizeof(null_no_quotes) - 1; + } else { + cp = null; + len = sizeof(null) - 1; + } + } + + /* + * Optimize the most common case, which is "%s". We just + * need to copy the complete string to the output buffer. + */ + if (xfp->xf_enc == need_enc + && xfp->xf_width[XF_WIDTH_MIN] < 0 + && xfp->xf_width[XF_WIDTH_SIZE] < 0 + && xfp->xf_width[XF_WIDTH_MAX] < 0 + && !(XOIF_ISSET(xop, XOIF_ANCHOR) + || XOF_ISSET(xop, XOF_COLUMNS))) { + len = strlen(cp); + xo_buf_escape(xop, xbp, cp, len, flags); + + /* + * Our caller expects xb_curp left untouched, so we have + * to reset it and return the number of bytes written to + * the buffer. + */ + off2 = xbp->xb_curp - xbp->xb_bufp; + rc = off2 - off; + xbp->xb_curp = xbp->xb_bufp + off; + + return rc; + } + } + + cols = xo_format_string_direct(xop, xbp, flags, wcp, cp, len, + xfp->xf_width[XF_WIDTH_MAX], + need_enc, xfp->xf_enc); + if (cols < 0) + goto bail; + + /* + * xo_buf_append* will move xb_curp, so we save/restore it. + */ + off2 = xbp->xb_curp - xbp->xb_bufp; + rc = off2 - off; + xbp->xb_curp = xbp->xb_bufp + off; + + if (cols < xfp->xf_width[XF_WIDTH_MIN]) { + /* + * Find the number of columns needed to display the string. + * If we have the original wide string, we just call wcswidth, + * but if we did the work ourselves, then we need to do it. + */ + int delta = xfp->xf_width[XF_WIDTH_MIN] - cols; + if (!xo_buf_has_room(xbp, xfp->xf_width[XF_WIDTH_MIN])) + goto bail; + + /* + * If seen_minus, then pad on the right; otherwise move it so + * we can pad on the left. + */ + if (xfp->xf_seen_minus) { + cp = xbp->xb_curp + rc; + } else { + cp = xbp->xb_curp; + memmove(xbp->xb_curp + delta, xbp->xb_curp, rc); + } + + /* Set the padding */ + memset(cp, (xfp->xf_leading_zero > 0) ? '0' : ' ', delta); + rc += delta; + cols += delta; + } + + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += cols; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += cols; + + return rc; + + bail: + xbp->xb_curp = xbp->xb_bufp + off; + return 0; +} + +/* + * Look backwards in a buffer to find a numeric value + */ +static int +xo_buf_find_last_number (xo_buffer_t *xbp, ssize_t start_offset) +{ + int rc = 0; /* Fail with zero */ + int digit = 1; + char *sp = xbp->xb_bufp; + char *cp = sp + start_offset; + + while (--cp >= sp) + if (isdigit((int) *cp)) + break; + + for ( ; cp >= sp; cp--) { + if (!isdigit((int) *cp)) + break; + rc += (*cp - '0') * digit; + digit *= 10; + } + + return rc; +} + +static ssize_t +xo_count_utf8_cols (const char *str, ssize_t len) +{ + ssize_t tlen; + wchar_t wc; + ssize_t cols = 0; + const char *ep = str + len; + + while (str < ep) { + tlen = xo_utf8_to_wc_len(str); + if (tlen < 0) /* Broken input is very bad */ + return cols; + + wc = xo_utf8_char(str, tlen); + if (wc == (wchar_t) -1) + return cols; + + /* We only print printable characters */ + if (iswprint((wint_t) wc)) { + /* + * Find the width-in-columns of this character, which must be done + * in wide characters, since we lack a mbswidth() function. + */ + ssize_t width = xo_wcwidth(wc); + if (width < 0) + width = iswcntrl(wc) ? 0 : 1; + + cols += width; + } + + str += tlen; + } + + return cols; +} + +#ifdef HAVE_GETTEXT +static inline const char * +xo_dgettext (xo_handle_t *xop, const char *str) +{ + const char *domainname = xop->xo_gt_domain; + const char *res; + + res = dgettext(domainname, str); + + if (XOF_ISSET(xop, XOF_LOG_GETTEXT)) + fprintf(stderr, "xo: gettext: %s%s%smsgid \"%s\" returns \"%s\"\n", + domainname ? "domain \"" : "", xo_printable(domainname), + domainname ? "\", " : "", xo_printable(str), xo_printable(res)); + + return res; +} + +static inline const char * +xo_dngettext (xo_handle_t *xop, const char *sing, const char *plural, + unsigned long int n) +{ + const char *domainname = xop->xo_gt_domain; + const char *res; + + res = dngettext(domainname, sing, plural, n); + if (XOF_ISSET(xop, XOF_LOG_GETTEXT)) + fprintf(stderr, "xo: gettext: %s%s%s" + "msgid \"%s\", msgid_plural \"%s\" (%lu) returns \"%s\"\n", + domainname ? "domain \"" : "", + xo_printable(domainname), domainname ? "\", " : "", + xo_printable(sing), + xo_printable(plural), n, xo_printable(res)); + + return res; +} +#else /* HAVE_GETTEXT */ +static inline const char * +xo_dgettext (xo_handle_t *xop UNUSED, const char *str) +{ + return str; +} + +static inline const char * +xo_dngettext (xo_handle_t *xop UNUSED, const char *singular, + const char *plural, unsigned long int n) +{ + return (n == 1) ? singular : plural; +} +#endif /* HAVE_GETTEXT */ + +/* + * This is really _re_formatting, since the normal format code has + * generated a beautiful string into xo_data, starting at + * start_offset. We need to see if it's plural, which means + * comma-separated options, or singular. Then we make the appropriate + * call to d[n]gettext() to get the locale-based version. Note that + * both input and output of gettext() this should be UTF-8. + */ +static ssize_t +xo_format_gettext (xo_handle_t *xop, xo_xff_flags_t flags, + ssize_t start_offset, ssize_t cols, int need_enc) +{ + xo_buffer_t *xbp = &xop->xo_data; + + if (!xo_buf_has_room(xbp, 1)) + return cols; + + xbp->xb_curp[0] = '\0'; /* NUL-terminate the input string */ + + char *cp = xbp->xb_bufp + start_offset; + ssize_t len = xbp->xb_curp - cp; + const char *newstr = NULL; + + /* + * The plural flag asks us to look backwards at the last numeric + * value rendered and disect the string into two pieces. + */ + if (flags & XFF_GT_PLURAL) { + int n = xo_buf_find_last_number(xbp, start_offset); + char *two = memchr(cp, (int) ',', len); + if (two == NULL) { + xo_failure(xop, "no comma in plural gettext field: '%s'", cp); + return cols; + } + + if (two == cp) { + xo_failure(xop, "nothing before comma in plural gettext " + "field: '%s'", cp); + return cols; + } + + if (two == xbp->xb_curp) { + xo_failure(xop, "nothing after comma in plural gettext " + "field: '%s'", cp); + return cols; + } + + *two++ = '\0'; + if (flags & XFF_GT_FIELD) { + newstr = xo_dngettext(xop, cp, two, n); + } else { + /* Don't do a gettext() look up, just get the plural form */ + newstr = (n == 1) ? cp : two; + } + + /* + * If we returned the first string, optimize a bit by + * backing up over comma + */ + if (newstr == cp) { + xbp->xb_curp = two - 1; /* One for comma */ + /* + * If the caller wanted UTF8, we're done; nothing changed, + * but we need to count the columns used. + */ + if (need_enc == XF_ENC_UTF8) + return xo_count_utf8_cols(cp, xbp->xb_curp - cp); + } + + } else { + /* The simple case (singular) */ + newstr = xo_dgettext(xop, cp); + + if (newstr == cp) { + /* If the caller wanted UTF8, we're done; nothing changed */ + if (need_enc == XF_ENC_UTF8) + return cols; + } + } + + /* + * Since the new string string might be in gettext's buffer or + * in the buffer (as the plural form), we make a copy. + */ + ssize_t nlen = strlen(newstr); + char *newcopy = alloca(nlen + 1); + memcpy(newcopy, newstr, nlen + 1); + + xbp->xb_curp = xbp->xb_bufp + start_offset; /* Reset the buffer */ + return xo_format_string_direct(xop, xbp, flags, NULL, newcopy, nlen, 0, + need_enc, XF_ENC_UTF8); +} + +static void +xo_data_append_content (xo_handle_t *xop, const char *str, ssize_t len, + xo_xff_flags_t flags) +{ + int cols; + int need_enc = xo_needed_encoding(xop); + ssize_t start_offset = xo_buf_offset(&xop->xo_data); + + cols = xo_format_string_direct(xop, &xop->xo_data, XFF_UNESCAPE | flags, + NULL, str, len, -1, + need_enc, XF_ENC_UTF8); + if (flags & XFF_GT_FLAGS) + cols = xo_format_gettext(xop, flags, start_offset, cols, need_enc); + + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += cols; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += cols; +} + +/** + * Bump one of the 'width' values in a format strings (e.g. "%40.50.60s"). + * @param xfp Formatting instructions + * @param digit Single digit (0-9) of input + */ +static void +xo_bump_width (xo_format_t *xfp, int digit) +{ + int *ip = &xfp->xf_width[xfp->xf_dots]; + + *ip = ((*ip > 0) ? *ip : 0) * 10 + digit; +} + +static ssize_t +xo_trim_ws (xo_buffer_t *xbp, ssize_t len) +{ + char *cp, *sp, *ep; + ssize_t delta; + + /* First trim leading space */ + for (cp = sp = xbp->xb_curp, ep = cp + len; cp < ep; cp++) { + if (*cp != ' ') + break; + } + + delta = cp - sp; + if (delta) { + len -= delta; + memmove(sp, cp, len); + } + + /* Then trim off the end */ + for (cp = xbp->xb_curp, sp = ep = cp + len; cp < ep; ep--) { + if (ep[-1] != ' ') + break; + } + + delta = sp - ep; + if (delta) { + len -= delta; + cp[len] = '\0'; + } + + return len; +} + +/* + * Interface to format a single field. The arguments are in xo_vap, + * and the format is in 'fmt'. If 'xbp' is null, we use xop->xo_data; + * this is the most common case. + */ +static ssize_t +xo_do_format_field (xo_handle_t *xop, xo_buffer_t *xbp, + const char *fmt, ssize_t flen, xo_xff_flags_t flags) +{ + xo_format_t xf; + const char *cp, *ep, *sp, *xp = NULL; + ssize_t rc, cols; + int style = (flags & XFF_XML) ? XO_STYLE_XML : xo_style(xop); + unsigned make_output = !(flags & XFF_NO_OUTPUT) ? 1 : 0; + int need_enc = xo_needed_encoding(xop); + int real_need_enc = need_enc; + ssize_t old_cols = xop->xo_columns; + + /* The gettext interface is UTF-8, so we'll need that for now */ + if (flags & XFF_GT_FIELD) + need_enc = XF_ENC_UTF8; + + if (xbp == NULL) + xbp = &xop->xo_data; + + ssize_t start_offset = xo_buf_offset(xbp); + + for (cp = fmt, ep = fmt + flen; cp < ep; cp++) { + /* + * Since we're starting a new field, save the starting offset. + * We'll need this later for field-related operations. + */ + + if (*cp != '%') { + add_one: + if (xp == NULL) + xp = cp; + + if (*cp == '\\' && cp[1] != '\0') + cp += 1; + continue; + + } else if (cp + 1 < ep && cp[1] == '%') { + cp += 1; + goto add_one; + } + + if (xp) { + if (make_output) { + cols = xo_format_string_direct(xop, xbp, flags | XFF_UNESCAPE, + NULL, xp, cp - xp, -1, + need_enc, XF_ENC_UTF8); + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += cols; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += cols; + } + + xp = NULL; + } + + bzero(&xf, sizeof(xf)); + xf.xf_leading_zero = -1; + xf.xf_width[0] = xf.xf_width[1] = xf.xf_width[2] = -1; + + /* + * "%@" starts an XO-specific set of flags: + * @X@ - XML-only field; ignored if style isn't XML + */ + if (cp[1] == '@') { + for (cp += 2; cp < ep; cp++) { + if (*cp == '@') { + break; + } + if (*cp == '*') { + /* + * '*' means there's a "%*.*s" value in vap that + * we want to ignore + */ + if (!XOF_ISSET(xop, XOF_NO_VA_ARG)) + va_arg(xop->xo_vap, int); + } + } + } + + /* Hidden fields are only visible to JSON and XML */ + if (XOF_ISSET(xop, XFF_ENCODE_ONLY)) { + if (style != XO_STYLE_XML + && !xo_style_is_encoding(xop)) + xf.xf_skip = 1; + } else if (XOF_ISSET(xop, XFF_DISPLAY_ONLY)) { + if (style != XO_STYLE_TEXT + && xo_style(xop) != XO_STYLE_HTML) + xf.xf_skip = 1; + } + + if (!make_output) + xf.xf_skip = 1; + + /* + * Looking at one piece of a format; find the end and + * call snprintf. Then advance xo_vap on our own. + * + * Note that 'n', 'v', and '$' are not supported. + */ + sp = cp; /* Save start pointer */ + for (cp += 1; cp < ep; cp++) { + if (*cp == 'l') + xf.xf_lflag += 1; + else if (*cp == 'h') + xf.xf_hflag += 1; + else if (*cp == 'j') + xf.xf_jflag += 1; + else if (*cp == 't') + xf.xf_tflag += 1; + else if (*cp == 'z') + xf.xf_zflag += 1; + else if (*cp == 'q') + xf.xf_qflag += 1; + else if (*cp == '.') { + if (++xf.xf_dots >= XF_WIDTH_NUM) { + xo_failure(xop, "Too many dots in format: '%s'", fmt); + return -1; + } + } else if (*cp == '-') + xf.xf_seen_minus = 1; + else if (isdigit((int) *cp)) { + if (xf.xf_leading_zero < 0) + xf.xf_leading_zero = (*cp == '0'); + xo_bump_width(&xf, *cp - '0'); + } else if (*cp == '*') { + xf.xf_stars += 1; + xf.xf_star[xf.xf_dots] = 1; + } else if (strchr("diouxXDOUeEfFgGaAcCsSpm", *cp) != NULL) + break; + else if (*cp == 'n' || *cp == 'v') { + xo_failure(xop, "unsupported format: '%s'", fmt); + return -1; + } + } + + if (cp == ep) + xo_failure(xop, "field format missing format character: %s", + fmt); + + xf.xf_fc = *cp; + + if (!XOF_ISSET(xop, XOF_NO_VA_ARG)) { + if (*cp == 's' || *cp == 'S') { + /* Handle "%*.*.*s" */ + int s; + for (s = 0; s < XF_WIDTH_NUM; s++) { + if (xf.xf_star[s]) { + xf.xf_width[s] = va_arg(xop->xo_vap, int); + + /* Normalize a negative width value */ + if (xf.xf_width[s] < 0) { + if (s == 0) { + xf.xf_width[0] = -xf.xf_width[0]; + xf.xf_seen_minus = 1; + } else + xf.xf_width[s] = -1; /* Ignore negative values */ + } + } + } + } + } + + /* If no max is given, it defaults to size */ + if (xf.xf_width[XF_WIDTH_MAX] < 0 && xf.xf_width[XF_WIDTH_SIZE] >= 0) + xf.xf_width[XF_WIDTH_MAX] = xf.xf_width[XF_WIDTH_SIZE]; + + if (xf.xf_fc == 'D' || xf.xf_fc == 'O' || xf.xf_fc == 'U') + xf.xf_lflag = 1; + + if (!xf.xf_skip) { + xo_buffer_t *fbp = &xop->xo_fmt; + ssize_t len = cp - sp + 1; + if (!xo_buf_has_room(fbp, len + 1)) + return -1; + + char *newfmt = fbp->xb_curp; + memcpy(newfmt, sp, len); + newfmt[0] = '%'; /* If we skipped over a "%@...@s" format */ + newfmt[len] = '\0'; + + /* + * Bad news: our strings are UTF-8, but the stock printf + * functions won't handle field widths for wide characters + * correctly. So we have to handle this ourselves. + */ + if (xop->xo_formatter == NULL + && (xf.xf_fc == 's' || xf.xf_fc == 'S' + || xf.xf_fc == 'm')) { + + xf.xf_enc = (xf.xf_fc == 'm') ? XF_ENC_UTF8 + : (xf.xf_lflag || (xf.xf_fc == 'S')) ? XF_ENC_WIDE + : xf.xf_hflag ? XF_ENC_LOCALE : XF_ENC_UTF8; + + rc = xo_format_string(xop, xbp, flags, &xf); + + if ((flags & XFF_TRIM_WS) && xo_style_is_encoding(xop)) + rc = xo_trim_ws(xbp, rc); + + } else { + ssize_t columns = rc = xo_vsnprintf(xop, xbp, newfmt, + xop->xo_vap); + + if (rc > 0) { + /* + * For XML and HTML, we need "&<>" processing; for JSON, + * it's quotes. Text gets nothing. + */ + switch (style) { + case XO_STYLE_XML: + if (flags & XFF_TRIM_WS) + columns = rc = xo_trim_ws(xbp, rc); + /* FALLTHRU */ + case XO_STYLE_HTML: + rc = xo_escape_xml(xbp, rc, (flags & XFF_ATTR)); + break; + + case XO_STYLE_JSON: + if (flags & XFF_TRIM_WS) + columns = rc = xo_trim_ws(xbp, rc); + rc = xo_escape_json(xbp, rc, 0); + break; + + case XO_STYLE_SDPARAMS: + if (flags & XFF_TRIM_WS) + columns = rc = xo_trim_ws(xbp, rc); + rc = xo_escape_sdparams(xbp, rc, 0); + break; + + case XO_STYLE_ENCODER: + if (flags & XFF_TRIM_WS) + columns = rc = xo_trim_ws(xbp, rc); + break; + } + + /* + * We can assume all the non-%s data we've + * added is ASCII, so the columns and bytes are the + * same. xo_format_string handles all the fancy + * string conversions and updates xo_anchor_columns + * accordingly. + */ + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += columns; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += columns; + } + } + + if (rc > 0) + xbp->xb_curp += rc; + } + + /* + * Now for the tricky part: we need to move the argument pointer + * along by the amount needed. + */ + if (!XOF_ISSET(xop, XOF_NO_VA_ARG)) { + + if (xf.xf_fc == 's' ||xf.xf_fc == 'S') { + /* + * The 'S' and 's' formats are normally handled in + * xo_format_string, but if we skipped it, then we + * need to pop it. + */ + if (xf.xf_skip) + va_arg(xop->xo_vap, char *); + + } else if (xf.xf_fc == 'm') { + /* Nothing on the stack for "%m" */ + + } else { + int s; + for (s = 0; s < XF_WIDTH_NUM; s++) { + if (xf.xf_star[s]) + va_arg(xop->xo_vap, int); + } + + if (strchr("diouxXDOU", xf.xf_fc) != NULL) { + if (xf.xf_hflag > 1) { + va_arg(xop->xo_vap, int); + + } else if (xf.xf_hflag > 0) { + va_arg(xop->xo_vap, int); + + } else if (xf.xf_lflag > 1) { + va_arg(xop->xo_vap, unsigned long long); + + } else if (xf.xf_lflag > 0) { + va_arg(xop->xo_vap, unsigned long); + + } else if (xf.xf_jflag > 0) { + va_arg(xop->xo_vap, intmax_t); + + } else if (xf.xf_tflag > 0) { + va_arg(xop->xo_vap, ptrdiff_t); + + } else if (xf.xf_zflag > 0) { + va_arg(xop->xo_vap, size_t); + + } else if (xf.xf_qflag > 0) { + va_arg(xop->xo_vap, quad_t); + + } else { + va_arg(xop->xo_vap, int); + } + } else if (strchr("eEfFgGaA", xf.xf_fc) != NULL) + if (xf.xf_lflag) + va_arg(xop->xo_vap, long double); + else + va_arg(xop->xo_vap, double); + + else if (xf.xf_fc == 'C' || (xf.xf_fc == 'c' && xf.xf_lflag)) + va_arg(xop->xo_vap, wint_t); + + else if (xf.xf_fc == 'c') + va_arg(xop->xo_vap, int); + + else if (xf.xf_fc == 'p') + va_arg(xop->xo_vap, void *); + } + } + } + + if (xp) { + if (make_output) { + cols = xo_format_string_direct(xop, xbp, flags | XFF_UNESCAPE, + NULL, xp, cp - xp, -1, + need_enc, XF_ENC_UTF8); + + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += cols; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += cols; + } + + xp = NULL; + } + + if (flags & XFF_GT_FLAGS) { + /* + * Handle gettext()ing the field by looking up the value + * and then copying it in, while converting to locale, if + * needed. + */ + ssize_t new_cols = xo_format_gettext(xop, flags, start_offset, + old_cols, real_need_enc); + + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += new_cols - old_cols; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += new_cols - old_cols; + } + + return 0; +} + +/* + * Remove any numeric precision/width format from the format string by + * inserting the "%" after the [0-9]+, returning the substring. + */ +static char * +xo_fix_encoding (xo_handle_t *xop UNUSED, char *encoding) +{ + char *cp = encoding; + + if (cp[0] != '%' || !isdigit((int) cp[1])) + return encoding; + + for (cp += 2; *cp; cp++) { + if (!isdigit((int) *cp)) + break; + } + + *--cp = '%'; /* Back off and insert the '%' */ + + return cp; +} + +static void +xo_color_append_html (xo_handle_t *xop) +{ + /* + * If the color buffer has content, we add it now. It's already + * prebuilt and ready, since we want to add it to every <div>. + */ + if (!xo_buf_is_empty(&xop->xo_color_buf)) { + xo_buffer_t *xbp = &xop->xo_color_buf; + + xo_data_append(xop, xbp->xb_bufp, xbp->xb_curp - xbp->xb_bufp); + } +} + +/* + * A wrapper for humanize_number that autoscales, since the + * HN_AUTOSCALE flag scales as needed based on the size of + * the output buffer, not the size of the value. I also + * wish HN_DECIMAL was more imperative, without the <10 + * test. But the boat only goes where we want when we hold + * the rudder, so xo_humanize fixes part of the problem. + */ +static ssize_t +xo_humanize (char *buf, ssize_t len, uint64_t value, int flags) +{ + int scale = 0; + + if (value) { + uint64_t left = value; + + if (flags & HN_DIVISOR_1000) { + for ( ; left; scale++) + left /= 1000; + } else { + for ( ; left; scale++) + left /= 1024; + } + scale -= 1; + } + + return xo_humanize_number(buf, len, value, "", scale, flags); +} + +/* + * This is an area where we can save information from the handle for + * later restoration. We need to know what data was rendered to know + * what needs cleaned up. + */ +typedef struct xo_humanize_save_s { + ssize_t xhs_offset; /* Saved xo_offset */ + ssize_t xhs_columns; /* Saved xo_columns */ + ssize_t xhs_anchor_columns; /* Saved xo_anchor_columns */ +} xo_humanize_save_t; + +/* + * Format a "humanized" value for a numeric, meaning something nice + * like "44M" instead of "44470272". We autoscale, choosing the + * most appropriate value for K/M/G/T/P/E based on the value given. + */ +static void +xo_format_humanize (xo_handle_t *xop, xo_buffer_t *xbp, + xo_humanize_save_t *savep, xo_xff_flags_t flags) +{ + if (XOF_ISSET(xop, XOF_NO_HUMANIZE)) + return; + + ssize_t end_offset = xbp->xb_curp - xbp->xb_bufp; + if (end_offset == savep->xhs_offset) /* Huh? Nothing to render */ + return; + + /* + * We have a string that's allegedly a number. We want to + * humanize it, which means turning it back into a number + * and calling xo_humanize_number on it. + */ + uint64_t value; + char *ep; + + xo_buf_append(xbp, "", 1); /* NUL-terminate it */ + + value = strtoull(xbp->xb_bufp + savep->xhs_offset, &ep, 0); + if (!(value == ULLONG_MAX && errno == ERANGE) + && (ep != xbp->xb_bufp + savep->xhs_offset)) { + /* + * There are few values where humanize_number needs + * more bytes than the original value. I've used + * 10 as a rectal number to cover those scenarios. + */ + if (xo_buf_has_room(xbp, 10)) { + xbp->xb_curp = xbp->xb_bufp + savep->xhs_offset; + + ssize_t rc; + ssize_t left = (xbp->xb_bufp + xbp->xb_size) - xbp->xb_curp; + int hn_flags = HN_NOSPACE; /* On by default */ + + if (flags & XFF_HN_SPACE) + hn_flags &= ~HN_NOSPACE; + + if (flags & XFF_HN_DECIMAL) + hn_flags |= HN_DECIMAL; + + if (flags & XFF_HN_1000) + hn_flags |= HN_DIVISOR_1000; + + rc = xo_humanize(xbp->xb_curp, left, value, hn_flags); + if (rc > 0) { + xbp->xb_curp += rc; + xop->xo_columns = savep->xhs_columns + rc; + xop->xo_anchor_columns = savep->xhs_anchor_columns + rc; + } + } + } +} + +/* + * Convenience function that either append a fixed value (if one is + * given) or formats a field using a format string. If it's + * encode_only, then we can't skip formatting the field, since it may + * be pulling arguments off the stack. + */ +static inline void +xo_simple_field (xo_handle_t *xop, unsigned encode_only, + const char *value, ssize_t vlen, + const char *fmt, ssize_t flen, xo_xff_flags_t flags) +{ + if (encode_only) + flags |= XFF_NO_OUTPUT; + + if (vlen == 0) + xo_do_format_field(xop, NULL, fmt, flen, flags); + else if (!encode_only) + xo_data_append_content(xop, value, vlen, flags); +} + +/* + * Html mode: append a <div> to the output buffer contain a field + * along with all the supporting information indicated by the flags. + */ +static void +xo_buf_append_div (xo_handle_t *xop, const char *class, xo_xff_flags_t flags, + const char *name, ssize_t nlen, + const char *value, ssize_t vlen, + const char *fmt, ssize_t flen, + const char *encoding, ssize_t elen) +{ + static char div_start[] = "<div class=\""; + static char div_tag[] = "\" data-tag=\""; + static char div_xpath[] = "\" data-xpath=\""; + static char div_key[] = "\" data-key=\"key"; + static char div_end[] = "\">"; + static char div_close[] = "</div>"; + + /* The encoding format defaults to the normal format */ + if (encoding == NULL && fmt != NULL) { + char *enc = alloca(flen + 1); + memcpy(enc, fmt, flen); + enc[flen] = '\0'; + encoding = xo_fix_encoding(xop, enc); + elen = strlen(encoding); + } + + /* + * To build our XPath predicate, we need to save the va_list before + * we format our data, and then restore it before we format the + * xpath expression. + * Display-only keys implies that we've got an encode-only key + * elsewhere, so we don't use them from making predicates. + */ + int need_predidate = + (name && (flags & XFF_KEY) && !(flags & XFF_DISPLAY_ONLY) + && XOF_ISSET(xop, XOF_XPATH)) ? 1 : 0; + + if (need_predidate) { + va_list va_local; + + va_copy(va_local, xop->xo_vap); + if (xop->xo_checkpointer) + xop->xo_checkpointer(xop, xop->xo_vap, 0); + + /* + * Build an XPath predicate expression to match this key. + * We use the format buffer. + */ + xo_buffer_t *pbp = &xop->xo_predicate; + pbp->xb_curp = pbp->xb_bufp; /* Restart buffer */ + + xo_buf_append(pbp, "[", 1); + xo_buf_escape(xop, pbp, name, nlen, 0); + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_buf_append(pbp, " = '", 4); + else + xo_buf_append(pbp, "='", 2); + + xo_xff_flags_t pflags = flags | XFF_XML | XFF_ATTR; + pflags &= ~(XFF_NO_OUTPUT | XFF_ENCODE_ONLY); + xo_do_format_field(xop, pbp, encoding, elen, pflags); + + xo_buf_append(pbp, "']", 2); + + /* Now we record this predicate expression in the stack */ + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + ssize_t olen = xsp->xs_keys ? strlen(xsp->xs_keys) : 0; + ssize_t dlen = pbp->xb_curp - pbp->xb_bufp; + + char *cp = xo_realloc(xsp->xs_keys, olen + dlen + 1); + if (cp) { + memcpy(cp + olen, pbp->xb_bufp, dlen); + cp[olen + dlen] = '\0'; + xsp->xs_keys = cp; + } + + /* Now we reset the xo_vap as if we were never here */ + va_end(xop->xo_vap); + va_copy(xop->xo_vap, va_local); + va_end(va_local); + if (xop->xo_checkpointer) + xop->xo_checkpointer(xop, xop->xo_vap, 1); + } + + if (flags & XFF_ENCODE_ONLY) { + /* + * Even if this is encode-only, we need to go through the + * work of formatting it to make sure the args are cleared + * from xo_vap. This is not true when vlen is zero, since + * that means our "value" isn't on the stack. + */ + xo_simple_field(xop, TRUE, NULL, 0, encoding, elen, flags); + return; + } + + xo_line_ensure_open(xop, 0); + + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_buf_indent(xop, xop->xo_indent_by); + + xo_data_append(xop, div_start, sizeof(div_start) - 1); + xo_data_append(xop, class, strlen(class)); + + /* + * If the color buffer has content, we add it now. It's already + * prebuilt and ready, since we want to add it to every <div>. + */ + if (!xo_buf_is_empty(&xop->xo_color_buf)) { + xo_buffer_t *xbp = &xop->xo_color_buf; + + xo_data_append(xop, xbp->xb_bufp, xbp->xb_curp - xbp->xb_bufp); + } + + if (name) { + xo_data_append(xop, div_tag, sizeof(div_tag) - 1); + xo_data_escape(xop, name, nlen); + + /* + * Save the offset at which we'd place units. See xo_format_units. + */ + if (XOF_ISSET(xop, XOF_UNITS)) { + XOIF_SET(xop, XOIF_UNITS_PENDING); + /* + * Note: We need the '+1' here because we know we've not + * added the closing quote. We add one, knowing the quote + * will be added shortly. + */ + xop->xo_units_offset = + xop->xo_data.xb_curp -xop->xo_data.xb_bufp + 1; + } + + if (XOF_ISSET(xop, XOF_XPATH)) { + int i; + xo_stack_t *xsp; + + xo_data_append(xop, div_xpath, sizeof(div_xpath) - 1); + if (xop->xo_leading_xpath) + xo_data_append(xop, xop->xo_leading_xpath, + strlen(xop->xo_leading_xpath)); + + for (i = 0; i <= xop->xo_depth; i++) { + xsp = &xop->xo_stack[i]; + if (xsp->xs_name == NULL) + continue; + + /* + * XSS_OPEN_LIST and XSS_OPEN_LEAF_LIST stack frames + * are directly under XSS_OPEN_INSTANCE frames so we + * don't need to put these in our XPath expressions. + */ + if (xsp->xs_state == XSS_OPEN_LIST + || xsp->xs_state == XSS_OPEN_LEAF_LIST) + continue; + + xo_data_append(xop, "/", 1); + xo_data_escape(xop, xsp->xs_name, strlen(xsp->xs_name)); + if (xsp->xs_keys) { + /* Don't show keys for the key field */ + if (i != xop->xo_depth || !(flags & XFF_KEY)) + xo_data_append(xop, xsp->xs_keys, strlen(xsp->xs_keys)); + } + } + + xo_data_append(xop, "/", 1); + xo_data_escape(xop, name, nlen); + } + + if (XOF_ISSET(xop, XOF_INFO) && xop->xo_info) { + static char in_type[] = "\" data-type=\""; + static char in_help[] = "\" data-help=\""; + + xo_info_t *xip = xo_info_find(xop, name, nlen); + if (xip) { + if (xip->xi_type) { + xo_data_append(xop, in_type, sizeof(in_type) - 1); + xo_data_escape(xop, xip->xi_type, strlen(xip->xi_type)); + } + if (xip->xi_help) { + xo_data_append(xop, in_help, sizeof(in_help) - 1); + xo_data_escape(xop, xip->xi_help, strlen(xip->xi_help)); + } + } + } + + if ((flags & XFF_KEY) && XOF_ISSET(xop, XOF_KEYS)) + xo_data_append(xop, div_key, sizeof(div_key) - 1); + } + + xo_buffer_t *xbp = &xop->xo_data; + ssize_t base_offset = xbp->xb_curp - xbp->xb_bufp; + + xo_data_append(xop, div_end, sizeof(div_end) - 1); + + xo_humanize_save_t save; /* Save values for humanizing logic */ + + save.xhs_offset = xbp->xb_curp - xbp->xb_bufp; + save.xhs_columns = xop->xo_columns; + save.xhs_anchor_columns = xop->xo_anchor_columns; + + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + + if (flags & XFF_HUMANIZE) { + /* + * Unlike text style, we want to retain the original value and + * stuff it into the "data-number" attribute. + */ + static const char div_number[] = "\" data-number=\""; + ssize_t div_len = sizeof(div_number) - 1; + + ssize_t end_offset = xbp->xb_curp - xbp->xb_bufp; + ssize_t olen = end_offset - save.xhs_offset; + + char *cp = alloca(olen + 1); + memcpy(cp, xbp->xb_bufp + save.xhs_offset, olen); + cp[olen] = '\0'; + + xo_format_humanize(xop, xbp, &save, flags); + + if (xo_buf_has_room(xbp, div_len + olen)) { + ssize_t new_offset = xbp->xb_curp - xbp->xb_bufp; + + + /* Move the humanized string off to the left */ + memmove(xbp->xb_bufp + base_offset + div_len + olen, + xbp->xb_bufp + base_offset, new_offset - base_offset); + + /* Copy the data_number attribute name */ + memcpy(xbp->xb_bufp + base_offset, div_number, div_len); + + /* Copy the original long value */ + memcpy(xbp->xb_bufp + base_offset + div_len, cp, olen); + xbp->xb_curp += div_len + olen; + } + } + + xo_data_append(xop, div_close, sizeof(div_close) - 1); + + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_data_append(xop, "\n", 1); +} + +static void +xo_format_text (xo_handle_t *xop, const char *str, ssize_t len) +{ + switch (xo_style(xop)) { + case XO_STYLE_TEXT: + xo_buf_append_locale(xop, &xop->xo_data, str, len); + break; + + case XO_STYLE_HTML: + xo_buf_append_div(xop, "text", 0, NULL, 0, str, len, NULL, 0, NULL, 0); + break; + } +} + +static void +xo_format_title (xo_handle_t *xop, xo_field_info_t *xfip, + const char *value, ssize_t vlen) +{ + const char *fmt = xfip->xfi_format; + ssize_t flen = xfip->xfi_flen; + xo_xff_flags_t flags = xfip->xfi_flags; + + static char div_open[] = "<div class=\"title"; + static char div_middle[] = "\">"; + static char div_close[] = "</div>"; + + if (flen == 0) { + fmt = "%s"; + flen = 2; + } + + switch (xo_style(xop)) { + case XO_STYLE_XML: + case XO_STYLE_JSON: + case XO_STYLE_SDPARAMS: + case XO_STYLE_ENCODER: + /* + * Even though we don't care about text, we need to do + * enough parsing work to skip over the right bits of xo_vap. + */ + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + return; + } + + xo_buffer_t *xbp = &xop->xo_data; + ssize_t start = xbp->xb_curp - xbp->xb_bufp; + ssize_t left = xbp->xb_size - start; + ssize_t rc; + + if (xo_style(xop) == XO_STYLE_HTML) { + xo_line_ensure_open(xop, 0); + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_buf_indent(xop, xop->xo_indent_by); + xo_buf_append(&xop->xo_data, div_open, sizeof(div_open) - 1); + xo_color_append_html(xop); + xo_buf_append(&xop->xo_data, div_middle, sizeof(div_middle) - 1); + } + + start = xbp->xb_curp - xbp->xb_bufp; /* Reset start */ + if (vlen) { + char *newfmt = alloca(flen + 1); + memcpy(newfmt, fmt, flen); + newfmt[flen] = '\0'; + + /* If len is non-zero, the format string apply to the name */ + char *newstr = alloca(vlen + 1); + memcpy(newstr, value, vlen); + newstr[vlen] = '\0'; + + if (newstr[vlen - 1] == 's') { + char *bp; + + rc = snprintf(NULL, 0, newfmt, newstr); + if (rc > 0) { + /* + * We have to do this the hard way, since we might need + * the columns. + */ + bp = alloca(rc + 1); + rc = snprintf(bp, rc + 1, newfmt, newstr); + + xo_data_append_content(xop, bp, rc, flags); + } + goto move_along; + + } else { + rc = snprintf(xbp->xb_curp, left, newfmt, newstr); + if (rc >= left) { + if (!xo_buf_has_room(xbp, rc)) + return; + left = xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); + rc = snprintf(xbp->xb_curp, left, newfmt, newstr); + } + + if (rc > 0) { + if (XOF_ISSET(xop, XOF_COLUMNS)) + xop->xo_columns += rc; + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xop->xo_anchor_columns += rc; + } + } + + } else { + xo_do_format_field(xop, NULL, fmt, flen, flags); + + /* xo_do_format_field moved curp, so we need to reset it */ + rc = xbp->xb_curp - (xbp->xb_bufp + start); + xbp->xb_curp = xbp->xb_bufp + start; + } + + /* If we're styling HTML, then we need to escape it */ + if (xo_style(xop) == XO_STYLE_HTML) { + rc = xo_escape_xml(xbp, rc, 0); + } + + if (rc > 0) + xbp->xb_curp += rc; + + move_along: + if (xo_style(xop) == XO_STYLE_HTML) { + xo_data_append(xop, div_close, sizeof(div_close) - 1); + if (XOF_ISSET(xop, XOF_PRETTY)) + xo_data_append(xop, "\n", 1); + } +} + +/* + * strspn() with a string length + */ +static ssize_t +xo_strnspn (const char *str, size_t len, const char *accept) +{ + ssize_t i; + const char *cp, *ep; + + for (i = 0, cp = str, ep = str + len; cp < ep && *cp != '\0'; i++, cp++) { + if (strchr(accept, *cp) == NULL) + break; + } + + return i; +} + +/* + * Decide if a format string should be considered "numeric", + * in the sense that the number does not need to be quoted. + * This means that it consists only of a single numeric field + * with nothing exotic or "interesting". This means that + * static values are never considered numeric. + */ +static int +xo_format_is_numeric (const char *fmt, ssize_t flen) +{ + if (flen <= 0 || *fmt++ != '%') /* Must start with '%' */ + return FALSE; + flen -= 1; + + /* Handle leading flags; don't want "#" since JSON can't handle hex */ + ssize_t spn = xo_strnspn(fmt, flen, "0123456789.*+ -"); + if (spn >= flen) + return FALSE; + + fmt += spn; /* Move along the input string */ + flen -= spn; + + /* Handle the length modifiers */ + spn = xo_strnspn(fmt, flen, "hljtqz"); + if (spn >= flen) + return FALSE; + + fmt += spn; /* Move along the input string */ + flen -= spn; + + if (flen != 1) /* Should only be one character left */ + return FALSE; + + return (strchr("diouDOUeEfFgG", *fmt) == NULL) ? FALSE : TRUE; +} + +/* + * Update the stack flags using the object flags, allowing callers + * to monkey with the stack flags without even knowing they exist. + */ +static void +xo_stack_set_flags (xo_handle_t *xop) +{ + if (XOF_ISSET(xop, XOF_NOT_FIRST)) { + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + + xsp->xs_flags |= XSF_NOT_FIRST; + XOF_CLEAR(xop, XOF_NOT_FIRST); + } +} + +static void +xo_format_prep (xo_handle_t *xop, xo_xff_flags_t flags) +{ + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) { + xo_data_append(xop, ",", 1); + if (!(flags & XFF_LEAF_LIST) && XOF_ISSET(xop, XOF_PRETTY)) + xo_data_append(xop, "\n", 1); + } else + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; +} + +#if 0 +/* Useful debugging function */ +void +xo_arg (xo_handle_t *xop); +void +xo_arg (xo_handle_t *xop) +{ + xop = xo_default(xop); + fprintf(stderr, "0x%x", va_arg(xop->xo_vap, unsigned)); +} +#endif /* 0 */ + +static void +xo_format_value (xo_handle_t *xop, const char *name, ssize_t nlen, + const char *value, ssize_t vlen, + const char *fmt, ssize_t flen, + const char *encoding, ssize_t elen, xo_xff_flags_t flags) +{ + int pretty = XOF_ISSET(xop, XOF_PRETTY); + int quote; + + /* + * Before we emit a value, we need to know that the frame is ready. + */ + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + + if (flags & XFF_LEAF_LIST) { + /* + * Check if we've already started to emit normal leafs + * or if we're not in a leaf list. + */ + if ((xsp->xs_flags & (XSF_EMIT | XSF_EMIT_KEY)) + || !(xsp->xs_flags & XSF_EMIT_LEAF_LIST)) { + char nbuf[nlen + 1]; + memcpy(nbuf, name, nlen); + nbuf[nlen] = '\0'; + + ssize_t rc = xo_transition(xop, 0, nbuf, XSS_EMIT_LEAF_LIST); + if (rc < 0) + flags |= XFF_DISPLAY_ONLY | XFF_ENCODE_ONLY; + else + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_EMIT_LEAF_LIST; + } + + xsp = &xop->xo_stack[xop->xo_depth]; + if (xsp->xs_name) { + name = xsp->xs_name; + nlen = strlen(name); + } + + } else if (flags & XFF_KEY) { + /* Emitting a 'k' (key) field */ + if ((xsp->xs_flags & XSF_EMIT) && !(flags & XFF_DISPLAY_ONLY)) { + xo_failure(xop, "key field emitted after normal value field: '%.*s'", + nlen, name); + + } else if (!(xsp->xs_flags & XSF_EMIT_KEY)) { + char nbuf[nlen + 1]; + memcpy(nbuf, name, nlen); + nbuf[nlen] = '\0'; + + ssize_t rc = xo_transition(xop, 0, nbuf, XSS_EMIT); + if (rc < 0) + flags |= XFF_DISPLAY_ONLY | XFF_ENCODE_ONLY; + else + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_EMIT_KEY; + + xsp = &xop->xo_stack[xop->xo_depth]; + xsp->xs_flags |= XSF_EMIT_KEY; + } + + } else { + /* Emitting a normal value field */ + if ((xsp->xs_flags & XSF_EMIT_LEAF_LIST) + || !(xsp->xs_flags & XSF_EMIT)) { + char nbuf[nlen + 1]; + memcpy(nbuf, name, nlen); + nbuf[nlen] = '\0'; + + ssize_t rc = xo_transition(xop, 0, nbuf, XSS_EMIT); + if (rc < 0) + flags |= XFF_DISPLAY_ONLY | XFF_ENCODE_ONLY; + else + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_EMIT; + + xsp = &xop->xo_stack[xop->xo_depth]; + xsp->xs_flags |= XSF_EMIT; + } + } + + xo_buffer_t *xbp = &xop->xo_data; + xo_humanize_save_t save; /* Save values for humanizing logic */ + + const char *leader = xo_xml_leader_len(xop, name, nlen); + + switch (xo_style(xop)) { + case XO_STYLE_TEXT: + if (flags & XFF_ENCODE_ONLY) + flags |= XFF_NO_OUTPUT; + + save.xhs_offset = xbp->xb_curp - xbp->xb_bufp; + save.xhs_columns = xop->xo_columns; + save.xhs_anchor_columns = xop->xo_anchor_columns; + + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + + if (flags & XFF_HUMANIZE) + xo_format_humanize(xop, xbp, &save, flags); + break; + + case XO_STYLE_HTML: + if (flags & XFF_ENCODE_ONLY) + flags |= XFF_NO_OUTPUT; + + xo_buf_append_div(xop, "data", flags, name, nlen, value, vlen, + fmt, flen, encoding, elen); + break; + + case XO_STYLE_XML: + /* + * Even though we're not making output, we still need to + * let the formatting code handle the va_arg popping. + */ + if (flags & XFF_DISPLAY_ONLY) { + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + break; + } + + if (encoding) { + fmt = encoding; + flen = elen; + } else { + char *enc = alloca(flen + 1); + memcpy(enc, fmt, flen); + enc[flen] = '\0'; + fmt = xo_fix_encoding(xop, enc); + flen = strlen(fmt); + } + + if (nlen == 0) { + static char missing[] = "missing-field-name"; + xo_failure(xop, "missing field name: %s", fmt); + name = missing; + nlen = sizeof(missing) - 1; + } + + if (pretty) + xo_buf_indent(xop, -1); + xo_data_append(xop, "<", 1); + if (*leader) + xo_data_append(xop, leader, 1); + xo_data_escape(xop, name, nlen); + + if (xop->xo_attrs.xb_curp != xop->xo_attrs.xb_bufp) { + xo_data_append(xop, xop->xo_attrs.xb_bufp, + xop->xo_attrs.xb_curp - xop->xo_attrs.xb_bufp); + xop->xo_attrs.xb_curp = xop->xo_attrs.xb_bufp; + } + + /* + * We indicate 'key' fields using the 'key' attribute. While + * this is really committing the crime of mixing meta-data with + * data, it's often useful. Especially when format meta-data is + * difficult to come by. + */ + if ((flags & XFF_KEY) && XOF_ISSET(xop, XOF_KEYS)) { + static char attr[] = " key=\"key\""; + xo_data_append(xop, attr, sizeof(attr) - 1); + } + + /* + * Save the offset at which we'd place units. See xo_format_units. + */ + if (XOF_ISSET(xop, XOF_UNITS)) { + XOIF_SET(xop, XOIF_UNITS_PENDING); + xop->xo_units_offset = xop->xo_data.xb_curp -xop->xo_data.xb_bufp; + } + + xo_data_append(xop, ">", 1); + + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + + xo_data_append(xop, "</", 2); + if (*leader) + xo_data_append(xop, leader, 1); + xo_data_escape(xop, name, nlen); + xo_data_append(xop, ">", 1); + if (pretty) + xo_data_append(xop, "\n", 1); + break; + + case XO_STYLE_JSON: + if (flags & XFF_DISPLAY_ONLY) { + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + break; + } + + if (encoding) { + fmt = encoding; + flen = elen; + } else { + char *enc = alloca(flen + 1); + memcpy(enc, fmt, flen); + enc[flen] = '\0'; + fmt = xo_fix_encoding(xop, enc); + flen = strlen(fmt); + } + + xo_stack_set_flags(xop); + + int first = (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + ? 0 : 1; + + xo_format_prep(xop, flags); + + if (flags & XFF_QUOTE) + quote = 1; + else if (flags & XFF_NOQUOTE) + quote = 0; + else if (vlen != 0) + quote = 1; + else if (flen == 0) { + quote = 0; + fmt = "true"; /* JSON encodes empty tags as a boolean true */ + flen = 4; + } else if (xo_format_is_numeric(fmt, flen)) + quote = 0; + else + quote = 1; + + if (nlen == 0) { + static char missing[] = "missing-field-name"; + xo_failure(xop, "missing field name: %s", fmt); + name = missing; + nlen = sizeof(missing) - 1; + } + + if (flags & XFF_LEAF_LIST) { + if (!first && pretty) + xo_data_append(xop, "\n", 1); + if (pretty) + xo_buf_indent(xop, -1); + } else { + if (pretty) + xo_buf_indent(xop, -1); + xo_data_append(xop, "\"", 1); + + xbp = &xop->xo_data; + ssize_t off = xbp->xb_curp - xbp->xb_bufp; + + xo_data_escape(xop, name, nlen); + + if (XOF_ISSET(xop, XOF_UNDERSCORES)) { + ssize_t coff = xbp->xb_curp - xbp->xb_bufp; + for ( ; off < coff; off++) + if (xbp->xb_bufp[off] == '-') + xbp->xb_bufp[off] = '_'; + } + xo_data_append(xop, "\":", 2); + if (pretty) + xo_data_append(xop, " ", 1); + } + + if (quote) + xo_data_append(xop, "\"", 1); + + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + + if (quote) + xo_data_append(xop, "\"", 1); + break; + + case XO_STYLE_SDPARAMS: + if (flags & XFF_DISPLAY_ONLY) { + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + break; + } + + if (encoding) { + fmt = encoding; + flen = elen; + } else { + char *enc = alloca(flen + 1); + memcpy(enc, fmt, flen); + enc[flen] = '\0'; + fmt = xo_fix_encoding(xop, enc); + flen = strlen(fmt); + } + + if (nlen == 0) { + static char missing[] = "missing-field-name"; + xo_failure(xop, "missing field name: %s", fmt); + name = missing; + nlen = sizeof(missing) - 1; + } + + xo_data_escape(xop, name, nlen); + xo_data_append(xop, "=\"", 2); + + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + + xo_data_append(xop, "\" ", 2); + break; + + case XO_STYLE_ENCODER: + if (flags & XFF_DISPLAY_ONLY) { + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + break; + } + + if (flags & XFF_QUOTE) + quote = 1; + else if (flags & XFF_NOQUOTE) + quote = 0; + else if (flen == 0) { + quote = 0; + fmt = "true"; /* JSON encodes empty tags as a boolean true */ + flen = 4; + } else if (strchr("diouxXDOUeEfFgGaAcCp", fmt[flen - 1]) == NULL) + quote = 1; + else + quote = 0; + + if (encoding) { + fmt = encoding; + flen = elen; + } else { + char *enc = alloca(flen + 1); + memcpy(enc, fmt, flen); + enc[flen] = '\0'; + fmt = xo_fix_encoding(xop, enc); + flen = strlen(fmt); + } + + if (nlen == 0) { + static char missing[] = "missing-field-name"; + xo_failure(xop, "missing field name: %s", fmt); + name = missing; + nlen = sizeof(missing) - 1; + } + + ssize_t name_offset = xo_buf_offset(&xop->xo_data); + xo_data_append(xop, name, nlen); + xo_data_append(xop, "", 1); + + ssize_t value_offset = xo_buf_offset(&xop->xo_data); + + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + + xo_data_append(xop, "", 1); + + xo_encoder_handle(xop, quote ? XO_OP_STRING : XO_OP_CONTENT, + xo_buf_data(&xop->xo_data, name_offset), + xo_buf_data(&xop->xo_data, value_offset), flags); + xo_buf_reset(&xop->xo_data); + break; + } +} + +static void +xo_set_gettext_domain (xo_handle_t *xop, xo_field_info_t *xfip, + const char *str, ssize_t len) +{ + const char *fmt = xfip->xfi_format; + ssize_t flen = xfip->xfi_flen; + + /* Start by discarding previous domain */ + if (xop->xo_gt_domain) { + xo_free(xop->xo_gt_domain); + xop->xo_gt_domain = NULL; + } + + /* An empty {G:} means no domainname */ + if (len == 0 && flen == 0) + return; + + ssize_t start_offset = -1; + if (len == 0 && flen != 0) { + /* Need to do format the data to get the domainname from args */ + start_offset = xop->xo_data.xb_curp - xop->xo_data.xb_bufp; + xo_do_format_field(xop, NULL, fmt, flen, 0); + + ssize_t end_offset = xop->xo_data.xb_curp - xop->xo_data.xb_bufp; + len = end_offset - start_offset; + str = xop->xo_data.xb_bufp + start_offset; + } + + xop->xo_gt_domain = xo_strndup(str, len); + + /* Reset the current buffer point to avoid emitting the name as output */ + if (start_offset >= 0) + xop->xo_data.xb_curp = xop->xo_data.xb_bufp + start_offset; +} + +static void +xo_format_content (xo_handle_t *xop, const char *class_name, + const char *tag_name, + const char *value, ssize_t vlen, + const char *fmt, ssize_t flen, + xo_xff_flags_t flags) +{ + switch (xo_style(xop)) { + case XO_STYLE_TEXT: + xo_simple_field(xop, FALSE, value, vlen, fmt, flen, flags); + break; + + case XO_STYLE_HTML: + xo_buf_append_div(xop, class_name, flags, NULL, 0, + value, vlen, fmt, flen, NULL, 0); + break; + + case XO_STYLE_XML: + case XO_STYLE_JSON: + case XO_STYLE_SDPARAMS: + if (tag_name) { + xo_open_container_h(xop, tag_name); + xo_format_value(xop, "message", 7, value, vlen, + fmt, flen, NULL, 0, flags); + xo_close_container_h(xop, tag_name); + + } else { + /* + * Even though we don't care about labels, we need to do + * enough parsing work to skip over the right bits of xo_vap. + */ + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + } + break; + + case XO_STYLE_ENCODER: + xo_simple_field(xop, TRUE, value, vlen, fmt, flen, flags); + break; + } +} + +static const char *xo_color_names[] = { + "default", /* XO_COL_DEFAULT */ + "black", /* XO_COL_BLACK */ + "red", /* XO_CLOR_RED */ + "green", /* XO_COL_GREEN */ + "yellow", /* XO_COL_YELLOW */ + "blue", /* XO_COL_BLUE */ + "magenta", /* XO_COL_MAGENTA */ + "cyan", /* XO_COL_CYAN */ + "white", /* XO_COL_WHITE */ + NULL +}; + +static int +xo_color_find (const char *str) +{ + int i; + + for (i = 0; xo_color_names[i]; i++) { + if (xo_streq(xo_color_names[i], str)) + return i; + } + + return -1; +} + +static const char *xo_effect_names[] = { + "reset", /* XO_EFF_RESET */ + "normal", /* XO_EFF_NORMAL */ + "bold", /* XO_EFF_BOLD */ + "underline", /* XO_EFF_UNDERLINE */ + "inverse", /* XO_EFF_INVERSE */ + NULL +}; + +static const char *xo_effect_on_codes[] = { + "0", /* XO_EFF_RESET */ + "0", /* XO_EFF_NORMAL */ + "1", /* XO_EFF_BOLD */ + "4", /* XO_EFF_UNDERLINE */ + "7", /* XO_EFF_INVERSE */ + NULL +}; + +#if 0 +/* + * See comment below re: joy of terminal standards. These can + * be use by just adding: + * + if (newp->xoc_effects & bit) + * code = xo_effect_on_codes[i]; + * + else + * + code = xo_effect_off_codes[i]; + * in xo_color_handle_text. + */ +static const char *xo_effect_off_codes[] = { + "0", /* XO_EFF_RESET */ + "0", /* XO_EFF_NORMAL */ + "21", /* XO_EFF_BOLD */ + "24", /* XO_EFF_UNDERLINE */ + "27", /* XO_EFF_INVERSE */ + NULL +}; +#endif /* 0 */ + +static int +xo_effect_find (const char *str) +{ + int i; + + for (i = 0; xo_effect_names[i]; i++) { + if (xo_streq(xo_effect_names[i], str)) + return i; + } + + return -1; +} + +static void +xo_colors_parse (xo_handle_t *xop, xo_colors_t *xocp, char *str) +{ + if (xo_text_only()) + return; + + char *cp, *ep, *np, *xp; + ssize_t len = strlen(str); + int rc; + + /* + * Possible tokens: colors, bg-colors, effects, no-effects, "reset". + */ + for (cp = str, ep = cp + len - 1; cp && cp < ep; cp = np) { + /* Trim leading whitespace */ + while (isspace((int) *cp)) + cp += 1; + + np = strchr(cp, ','); + if (np) + *np++ = '\0'; + + /* Trim trailing whitespace */ + xp = cp + strlen(cp) - 1; + while (isspace(*xp) && xp > cp) + *xp-- = '\0'; + + if (cp[0] == 'f' && cp[1] == 'g' && cp[2] == '-') { + rc = xo_color_find(cp + 3); + if (rc < 0) + goto unknown; + + xocp->xoc_col_fg = rc; + + } else if (cp[0] == 'b' && cp[1] == 'g' && cp[2] == '-') { + rc = xo_color_find(cp + 3); + if (rc < 0) + goto unknown; + xocp->xoc_col_bg = rc; + + } else if (cp[0] == 'n' && cp[1] == 'o' && cp[2] == '-') { + rc = xo_effect_find(cp + 3); + if (rc < 0) + goto unknown; + xocp->xoc_effects &= ~(1 << rc); + + } else { + rc = xo_effect_find(cp); + if (rc < 0) + goto unknown; + xocp->xoc_effects |= 1 << rc; + + switch (1 << rc) { + case XO_EFF_RESET: + xocp->xoc_col_fg = xocp->xoc_col_bg = 0; + /* Note: not "|=" since we want to wipe out the old value */ + xocp->xoc_effects = XO_EFF_RESET; + break; + + case XO_EFF_NORMAL: + xocp->xoc_effects &= ~(XO_EFF_BOLD | XO_EFF_UNDERLINE + | XO_EFF_INVERSE | XO_EFF_NORMAL); + break; + } + } + continue; + + unknown: + if (XOF_ISSET(xop, XOF_WARN)) + xo_failure(xop, "unknown color/effect string detected: '%s'", cp); + } +} + +static inline int +xo_colors_enabled (xo_handle_t *xop UNUSED) +{ +#ifdef LIBXO_TEXT_ONLY + return 0; +#else /* LIBXO_TEXT_ONLY */ + return XOF_ISSET(xop, XOF_COLOR); +#endif /* LIBXO_TEXT_ONLY */ +} + +/* + * If the color map is in use (--libxo colors=xxxx), then update + * the incoming foreground and background colors from the map. + */ +static void +xo_colors_update (xo_handle_t *xop UNUSED, xo_colors_t *newp UNUSED) +{ +#ifndef LIBXO_TEXT_ONLY + xo_color_t fg = newp->xoc_col_fg; + if (XOF_ISSET(xop, XOF_COLOR_MAP) && fg < XO_NUM_COLORS) + fg = xop->xo_color_map_fg[fg]; /* Fetch from color map */ + newp->xoc_col_fg = fg; + + xo_color_t bg = newp->xoc_col_bg; + if (XOF_ISSET(xop, XOF_COLOR_MAP) && bg < XO_NUM_COLORS) + bg = xop->xo_color_map_bg[bg]; /* Fetch from color map */ + newp->xoc_col_bg = bg; +#endif /* LIBXO_TEXT_ONLY */ +} + +static void +xo_colors_handle_text (xo_handle_t *xop, xo_colors_t *newp) +{ + char buf[BUFSIZ]; + char *cp = buf, *ep = buf + sizeof(buf); + unsigned i, bit; + xo_colors_t *oldp = &xop->xo_colors; + const char *code = NULL; + + /* + * Start the buffer with an escape. We don't want to add the '[' + * now, since we let xo_effect_text_add unconditionally add the ';'. + * We'll replace the first ';' with a '[' when we're done. + */ + *cp++ = 0x1b; /* Escape */ + + /* + * Terminals were designed back in the age before "certainty" was + * invented, when standards were more what you'd call "guidelines" + * than actual rules. Anyway we can't depend on them to operate + * correctly. So when display attributes are changed, we punt, + * reseting them all and turning back on the ones we want to keep. + * Longer, but should be completely reliable. Savvy? + */ + if (oldp->xoc_effects != (newp->xoc_effects & oldp->xoc_effects)) { + newp->xoc_effects |= XO_EFF_RESET; + oldp->xoc_effects = 0; + } + + for (i = 0, bit = 1; xo_effect_names[i]; i++, bit <<= 1) { + if ((newp->xoc_effects & bit) == (oldp->xoc_effects & bit)) + continue; + + code = xo_effect_on_codes[i]; + + cp += snprintf(cp, ep - cp, ";%s", code); + if (cp >= ep) + return; /* Should not occur */ + + if (bit == XO_EFF_RESET) { + /* Mark up the old value so we can detect current values as new */ + oldp->xoc_effects = 0; + oldp->xoc_col_fg = oldp->xoc_col_bg = XO_COL_DEFAULT; + } + } + + xo_color_t fg = newp->xoc_col_fg; + if (fg != oldp->xoc_col_fg) { + cp += snprintf(cp, ep - cp, ";3%u", + (fg != XO_COL_DEFAULT) ? fg - 1 : 9); + } + + xo_color_t bg = newp->xoc_col_bg; + if (bg != oldp->xoc_col_bg) { + cp += snprintf(cp, ep - cp, ";4%u", + (bg != XO_COL_DEFAULT) ? bg - 1 : 9); + } + + if (cp - buf != 1 && cp < ep - 3) { + buf[1] = '['; /* Overwrite leading ';' */ + *cp++ = 'm'; + *cp = '\0'; + xo_buf_append(&xop->xo_data, buf, cp - buf); + } +} + +static void +xo_colors_handle_html (xo_handle_t *xop, xo_colors_t *newp) +{ + xo_colors_t *oldp = &xop->xo_colors; + + /* + * HTML colors are mostly trivial: fill in xo_color_buf with + * a set of class tags representing the colors and effects. + */ + + /* If nothing changed, then do nothing */ + if (oldp->xoc_effects == newp->xoc_effects + && oldp->xoc_col_fg == newp->xoc_col_fg + && oldp->xoc_col_bg == newp->xoc_col_bg) + return; + + unsigned i, bit; + xo_buffer_t *xbp = &xop->xo_color_buf; + + xo_buf_reset(xbp); /* We rebuild content after each change */ + + for (i = 0, bit = 1; xo_effect_names[i]; i++, bit <<= 1) { + if (!(newp->xoc_effects & bit)) + continue; + + xo_buf_append_str(xbp, " effect-"); + xo_buf_append_str(xbp, xo_effect_names[i]); + } + + const char *fg = NULL; + const char *bg = NULL; + + if (newp->xoc_col_fg != XO_COL_DEFAULT) + fg = xo_color_names[newp->xoc_col_fg]; + if (newp->xoc_col_bg != XO_COL_DEFAULT) + bg = xo_color_names[newp->xoc_col_bg]; + + if (newp->xoc_effects & XO_EFF_INVERSE) { + const char *tmp = fg; + fg = bg; + bg = tmp; + if (fg == NULL) + fg = "inverse"; + if (bg == NULL) + bg = "inverse"; + + } + + if (fg) { + xo_buf_append_str(xbp, " color-fg-"); + xo_buf_append_str(xbp, fg); + } + + if (bg) { + xo_buf_append_str(xbp, " color-bg-"); + xo_buf_append_str(xbp, bg); + } +} + +static void +xo_format_colors (xo_handle_t *xop, xo_field_info_t *xfip, + const char *value, ssize_t vlen) +{ + const char *fmt = xfip->xfi_format; + ssize_t flen = xfip->xfi_flen; + + xo_buffer_t xb; + + /* If the string is static and we've in an encoding style, bail */ + if (vlen != 0 && xo_style_is_encoding(xop)) + return; + + xo_buf_init(&xb); + + if (vlen) + xo_buf_append(&xb, value, vlen); + else if (flen) + xo_do_format_field(xop, &xb, fmt, flen, 0); + else + xo_buf_append(&xb, "reset", 6); /* Default if empty */ + + if (xo_colors_enabled(xop)) { + switch (xo_style(xop)) { + case XO_STYLE_TEXT: + case XO_STYLE_HTML: + xo_buf_append(&xb, "", 1); + + xo_colors_t xoc = xop->xo_colors; + xo_colors_parse(xop, &xoc, xb.xb_bufp); + xo_colors_update(xop, &xoc); + + if (xo_style(xop) == XO_STYLE_TEXT) { + /* + * Text mode means emitting the colors as ANSI character + * codes. This will allow people who like colors to have + * colors. The issue is, of course conflicting with the + * user's perfectly reasonable color scheme. Which leads + * to the hell of LSCOLORS, where even app need to have + * customization hooks for adjusting colors. Instead we + * provide a simpler-but-still-annoying answer where one + * can map colors to other colors. + */ + xo_colors_handle_text(xop, &xoc); + xoc.xoc_effects &= ~XO_EFF_RESET; /* After handling it */ + + } else { + /* + * HTML output is wrapped in divs, so the color information + * must appear in every div until cleared. Most pathetic. + * Most unavoidable. + */ + xoc.xoc_effects &= ~XO_EFF_RESET; /* Before handling effects */ + xo_colors_handle_html(xop, &xoc); + } + + xop->xo_colors = xoc; + break; + + case XO_STYLE_XML: + case XO_STYLE_JSON: + case XO_STYLE_SDPARAMS: + case XO_STYLE_ENCODER: + /* + * Nothing to do; we did all that work just to clear the stack of + * formatting arguments. + */ + break; + } + } + + xo_buf_cleanup(&xb); +} + +static void +xo_format_units (xo_handle_t *xop, xo_field_info_t *xfip, + const char *value, ssize_t vlen) +{ + const char *fmt = xfip->xfi_format; + ssize_t flen = xfip->xfi_flen; + xo_xff_flags_t flags = xfip->xfi_flags; + + static char units_start_xml[] = " units=\""; + static char units_start_html[] = " data-units=\""; + + if (!XOIF_ISSET(xop, XOIF_UNITS_PENDING)) { + xo_format_content(xop, "units", NULL, value, vlen, fmt, flen, flags); + return; + } + + xo_buffer_t *xbp = &xop->xo_data; + ssize_t start = xop->xo_units_offset; + ssize_t stop = xbp->xb_curp - xbp->xb_bufp; + + if (xo_style(xop) == XO_STYLE_XML) + xo_buf_append(xbp, units_start_xml, sizeof(units_start_xml) - 1); + else if (xo_style(xop) == XO_STYLE_HTML) + xo_buf_append(xbp, units_start_html, sizeof(units_start_html) - 1); + else + return; + + if (vlen) + xo_data_escape(xop, value, vlen); + else + xo_do_format_field(xop, NULL, fmt, flen, flags); + + xo_buf_append(xbp, "\"", 1); + + ssize_t now = xbp->xb_curp - xbp->xb_bufp; + ssize_t delta = now - stop; + if (delta <= 0) { /* Strange; no output to move */ + xbp->xb_curp = xbp->xb_bufp + stop; /* Reset buffer to prior state */ + return; + } + + /* + * Now we're in it alright. We've need to insert the unit value + * we just created into the right spot. We make a local copy, + * move it and then insert our copy. We know there's room in the + * buffer, since we're just moving this around. + */ + char *buf = alloca(delta); + + memcpy(buf, xbp->xb_bufp + stop, delta); + memmove(xbp->xb_bufp + start + delta, xbp->xb_bufp + start, stop - start); + memmove(xbp->xb_bufp + start, buf, delta); +} + +static ssize_t +xo_find_width (xo_handle_t *xop, xo_field_info_t *xfip, + const char *value, ssize_t vlen) +{ + const char *fmt = xfip->xfi_format; + ssize_t flen = xfip->xfi_flen; + + long width = 0; + char *bp; + char *cp; + + if (vlen) { + bp = alloca(vlen + 1); /* Make local NUL-terminated copy of value */ + memcpy(bp, value, vlen); + bp[vlen] = '\0'; + + width = strtol(bp, &cp, 0); + if (width == LONG_MIN || width == LONG_MAX || bp == cp || *cp != '\0') { + width = 0; + xo_failure(xop, "invalid width for anchor: '%s'", bp); + } + } else if (flen) { + /* + * We really expect the format for width to be "{:/%d}" or + * "{:/%u}", so if that's the case, we just grab our width off + * the argument list. But we need to avoid optimized logic if + * there's a custom formatter. + */ + if (xop->xo_formatter == NULL && flen == 2 + && strncmp("%d", fmt, flen) == 0) { + if (!XOF_ISSET(xop, XOF_NO_VA_ARG)) + width = va_arg(xop->xo_vap, int); + } else if (xop->xo_formatter == NULL && flen == 2 + && strncmp("%u", fmt, flen) == 0) { + if (!XOF_ISSET(xop, XOF_NO_VA_ARG)) + width = va_arg(xop->xo_vap, unsigned); + } else { + /* + * So we have a format and it's not a simple one like + * "{:/%d}". That means we need to format the field, + * extract the value from the formatted output, and then + * discard that output. + */ + int anchor_was_set = FALSE; + xo_buffer_t *xbp = &xop->xo_data; + ssize_t start_offset = xo_buf_offset(xbp); + bp = xo_buf_cur(xbp); /* Save start of the string */ + cp = NULL; + + if (XOIF_ISSET(xop, XOIF_ANCHOR)) { + XOIF_CLEAR(xop, XOIF_ANCHOR); + anchor_was_set = TRUE; + } + + ssize_t rc = xo_do_format_field(xop, xbp, fmt, flen, 0); + if (rc >= 0) { + xo_buf_append(xbp, "", 1); /* Append a NUL */ + + width = strtol(bp, &cp, 0); + if (width == LONG_MIN || width == LONG_MAX + || bp == cp || *cp != '\0') { + width = 0; + xo_failure(xop, "invalid width for anchor: '%s'", bp); + } + } + + /* Reset the cur pointer to where we found it */ + xbp->xb_curp = xbp->xb_bufp + start_offset; + if (anchor_was_set) + XOIF_SET(xop, XOIF_ANCHOR); + } + } + + return width; +} + +static void +xo_anchor_clear (xo_handle_t *xop) +{ + XOIF_CLEAR(xop, XOIF_ANCHOR); + xop->xo_anchor_offset = 0; + xop->xo_anchor_columns = 0; + xop->xo_anchor_min_width = 0; +} + +/* + * An anchor is a marker used to delay field width implications. + * Imagine the format string "{[:10}{min:%d}/{cur:%d}/{max:%d}{:]}". + * We are looking for output like " 1/4/5" + * + * To make this work, we record the anchor and then return to + * format it when the end anchor tag is seen. + */ +static void +xo_anchor_start (xo_handle_t *xop, xo_field_info_t *xfip, + const char *value, ssize_t vlen) +{ + if (XOIF_ISSET(xop, XOIF_ANCHOR)) + xo_failure(xop, "the anchor already recording is discarded"); + + XOIF_SET(xop, XOIF_ANCHOR); + xo_buffer_t *xbp = &xop->xo_data; + xop->xo_anchor_offset = xbp->xb_curp - xbp->xb_bufp; + xop->xo_anchor_columns = 0; + + /* + * Now we find the width, if possible. If it's not there, + * we'll get it on the end anchor. + */ + xop->xo_anchor_min_width = xo_find_width(xop, xfip, value, vlen); +} + +static void +xo_anchor_stop (xo_handle_t *xop, xo_field_info_t *xfip, + const char *value, ssize_t vlen) +{ + if (!XOIF_ISSET(xop, XOIF_ANCHOR)) { + xo_failure(xop, "no start anchor"); + return; + } + + XOIF_CLEAR(xop, XOIF_UNITS_PENDING); + + ssize_t width = xo_find_width(xop, xfip, value, vlen); + if (width == 0) + width = xop->xo_anchor_min_width; + + if (width == 0) /* No width given; nothing to do */ + goto done; + + xo_buffer_t *xbp = &xop->xo_data; + ssize_t start = xop->xo_anchor_offset; + ssize_t stop = xbp->xb_curp - xbp->xb_bufp; + ssize_t abswidth = (width > 0) ? width : -width; + ssize_t blen = abswidth - xop->xo_anchor_columns; + + if (blen <= 0) /* Already over width */ + goto done; + + if (abswidth > XO_MAX_ANCHOR_WIDTH) { + xo_failure(xop, "width over %u are not supported", + XO_MAX_ANCHOR_WIDTH); + goto done; + } + + /* Make a suitable padding field and emit it */ + char *buf = alloca(blen); + memset(buf, ' ', blen); + xo_format_content(xop, "padding", NULL, buf, blen, NULL, 0, 0); + + if (width < 0) /* Already left justified */ + goto done; + + ssize_t now = xbp->xb_curp - xbp->xb_bufp; + ssize_t delta = now - stop; + if (delta <= 0) /* Strange; no output to move */ + goto done; + + /* + * Now we're in it alright. We've need to insert the padding data + * we just created (which might be an HTML <div> or text) before + * the formatted data. We make a local copy, move it and then + * insert our copy. We know there's room in the buffer, since + * we're just moving this around. + */ + if (delta > blen) + buf = alloca(delta); /* Expand buffer if needed */ + + memcpy(buf, xbp->xb_bufp + stop, delta); + memmove(xbp->xb_bufp + start + delta, xbp->xb_bufp + start, stop - start); + memmove(xbp->xb_bufp + start, buf, delta); + + done: + xo_anchor_clear(xop); +} + +static const char * +xo_class_name (int ftype) +{ + switch (ftype) { + case 'D': return "decoration"; + case 'E': return "error"; + case 'L': return "label"; + case 'N': return "note"; + case 'P': return "padding"; + case 'W': return "warning"; + } + + return NULL; +} + +static const char * +xo_tag_name (int ftype) +{ + switch (ftype) { + case 'E': return "__error"; + case 'W': return "__warning"; + } + + return NULL; +} + +static int +xo_role_wants_default_format (int ftype) +{ + switch (ftype) { + /* These roles can be completely empty and/or without formatting */ + case 'C': + case 'G': + case '[': + case ']': + return 0; + } + + return 1; +} + +static xo_mapping_t xo_role_names[] = { + { 'C', "color" }, + { 'D', "decoration" }, + { 'E', "error" }, + { 'L', "label" }, + { 'N', "note" }, + { 'P', "padding" }, + { 'T', "title" }, + { 'U', "units" }, + { 'V', "value" }, + { 'W', "warning" }, + { '[', "start-anchor" }, + { ']', "stop-anchor" }, + { 0, NULL } +}; + +#define XO_ROLE_EBRACE '{' /* Escaped braces */ +#define XO_ROLE_TEXT '+' +#define XO_ROLE_NEWLINE '\n' + +static xo_mapping_t xo_modifier_names[] = { + { XFF_ARGUMENT, "argument" }, + { XFF_COLON, "colon" }, + { XFF_COMMA, "comma" }, + { XFF_DISPLAY_ONLY, "display" }, + { XFF_ENCODE_ONLY, "encoding" }, + { XFF_GT_FIELD, "gettext" }, + { XFF_HUMANIZE, "humanize" }, + { XFF_HUMANIZE, "hn" }, + { XFF_HN_SPACE, "hn-space" }, + { XFF_HN_DECIMAL, "hn-decimal" }, + { XFF_HN_1000, "hn-1000" }, + { XFF_KEY, "key" }, + { XFF_LEAF_LIST, "leaf-list" }, + { XFF_LEAF_LIST, "list" }, + { XFF_NOQUOTE, "no-quotes" }, + { XFF_NOQUOTE, "no-quote" }, + { XFF_GT_PLURAL, "plural" }, + { XFF_QUOTE, "quotes" }, + { XFF_QUOTE, "quote" }, + { XFF_TRIM_WS, "trim" }, + { XFF_WS, "white" }, + { 0, NULL } +}; + +#ifdef NOT_NEEDED_YET +static xo_mapping_t xo_modifier_short_names[] = { + { XFF_COLON, "c" }, + { XFF_DISPLAY_ONLY, "d" }, + { XFF_ENCODE_ONLY, "e" }, + { XFF_GT_FIELD, "g" }, + { XFF_HUMANIZE, "h" }, + { XFF_KEY, "k" }, + { XFF_LEAF_LIST, "l" }, + { XFF_NOQUOTE, "n" }, + { XFF_GT_PLURAL, "p" }, + { XFF_QUOTE, "q" }, + { XFF_TRIM_WS, "t" }, + { XFF_WS, "w" }, + { 0, NULL } +}; +#endif /* NOT_NEEDED_YET */ + +static int +xo_count_fields (xo_handle_t *xop UNUSED, const char *fmt) +{ + int rc = 1; + const char *cp; + + for (cp = fmt; *cp; cp++) + if (*cp == '{' || *cp == '\n') + rc += 1; + + return rc * 2 + 1; +} + +/* + * The field format is: + * '{' modifiers ':' content [ '/' print-fmt [ '/' encode-fmt ]] '}' + * Roles are optional and include the following field types: + * 'D': decoration; something non-text and non-data (colons, commmas) + * 'E': error message + * 'G': gettext() the entire string; optional domainname as content + * 'L': label; text preceding data + * 'N': note; text following data + * 'P': padding; whitespace + * 'T': Title, where 'content' is a column title + * 'U': Units, where 'content' is the unit label + * 'V': value, where 'content' is the name of the field (the default) + * 'W': warning message + * '[': start a section of anchored text + * ']': end a section of anchored text + * The following modifiers are also supported: + * 'a': content is provided via argument (const char *), not descriptor + * 'c': flag: emit a colon after the label + * 'd': field is only emitted for display styles (text and html) + * 'e': field is only emitted for encoding styles (xml and json) + * 'g': gettext() the field + * 'h': humanize a numeric value (only for display styles) + * 'k': this field is a key, suitable for XPath predicates + * 'l': a leaf-list, a simple list of values + * 'n': no quotes around this field + * 'p': the field has plural gettext semantics (ngettext) + * 'q': add quotes around this field + * 't': trim whitespace around the value + * 'w': emit a blank after the label + * The print-fmt and encode-fmt strings is the printf-style formating + * for this data. JSON and XML will use the encoding-fmt, if present. + * If the encode-fmt is not provided, it defaults to the print-fmt. + * If the print-fmt is not provided, it defaults to 's'. + */ +static const char * +xo_parse_roles (xo_handle_t *xop, const char *fmt, + const char *basep, xo_field_info_t *xfip) +{ + const char *sp; + unsigned ftype = 0; + xo_xff_flags_t flags = 0; + uint8_t fnum = 0; + + for (sp = basep; sp && *sp; sp++) { + if (*sp == ':' || *sp == '/' || *sp == '}') + break; + + if (*sp == '\\') { + if (sp[1] == '\0') { + xo_failure(xop, "backslash at the end of string"); + return NULL; + } + + /* Anything backslashed is ignored */ + sp += 1; + continue; + } + + if (*sp == ',') { + const char *np; + for (np = ++sp; *np; np++) + if (*np == ':' || *np == '/' || *np == '}' || *np == ',') + break; + + ssize_t slen = np - sp; + if (slen > 0) { + xo_xff_flags_t value; + + value = xo_name_lookup(xo_role_names, sp, slen); + if (value) + ftype = value; + else { + value = xo_name_lookup(xo_modifier_names, sp, slen); + if (value) + flags |= value; + else + xo_failure(xop, "unknown keyword ignored: '%.*s'", + slen, sp); + } + } + + sp = np - 1; + continue; + } + + switch (*sp) { + case 'C': + case 'D': + case 'E': + case 'G': + case 'L': + case 'N': + case 'P': + case 'T': + case 'U': + case 'V': + case 'W': + case '[': + case ']': + if (ftype != 0) { + xo_failure(xop, "field descriptor uses multiple types: '%s'", + xo_printable(fmt)); + return NULL; + } + ftype = *sp; + break; + + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + fnum = (fnum * 10) + (*sp - '0'); + break; + + case 'a': + flags |= XFF_ARGUMENT; + break; + + case 'c': + flags |= XFF_COLON; + break; + + case 'd': + flags |= XFF_DISPLAY_ONLY; + break; + + case 'e': + flags |= XFF_ENCODE_ONLY; + break; + + case 'g': + flags |= XFF_GT_FIELD; + break; + + case 'h': + flags |= XFF_HUMANIZE; + break; + + case 'k': + flags |= XFF_KEY; + break; + + case 'l': + flags |= XFF_LEAF_LIST; + break; + + case 'n': + flags |= XFF_NOQUOTE; + break; + + case 'p': + flags |= XFF_GT_PLURAL; + break; + + case 'q': + flags |= XFF_QUOTE; + break; + + case 't': + flags |= XFF_TRIM_WS; + break; + + case 'w': + flags |= XFF_WS; + break; + + default: + xo_failure(xop, "field descriptor uses unknown modifier: '%s'", + xo_printable(fmt)); + /* + * No good answer here; a bad format will likely + * mean a core file. We just return and hope + * the caller notices there's no output, and while + * that seems, well, bad, there's nothing better. + */ + return NULL; + } + + if (ftype == 'N' || ftype == 'U') { + if (flags & XFF_COLON) { + xo_failure(xop, "colon modifier on 'N' or 'U' field ignored: " + "'%s'", xo_printable(fmt)); + flags &= ~XFF_COLON; + } + } + } + + xfip->xfi_flags = flags; + xfip->xfi_ftype = ftype ?: 'V'; + xfip->xfi_fnum = fnum; + + return sp; +} + +/* + * Number any remaining fields that need numbers. Note that some + * field types (text, newline, escaped braces) never get numbers. + */ +static void +xo_gettext_finish_numbering_fields (xo_handle_t *xop UNUSED, + const char *fmt UNUSED, + xo_field_info_t *fields) +{ + xo_field_info_t *xfip; + unsigned fnum, max_fields; + uint64_t bits = 0; + const uint64_t one = 1; /* Avoid "1ULL" */ + + /* First make a list of add the explicitly used bits */ + for (xfip = fields, fnum = 0; xfip->xfi_ftype; xfip++) { + switch (xfip->xfi_ftype) { + case XO_ROLE_NEWLINE: /* Don't get numbered */ + case XO_ROLE_TEXT: + case XO_ROLE_EBRACE: + case 'G': + continue; + } + + fnum += 1; + if (fnum >= 63) + break; + + if (xfip->xfi_fnum) + bits |= one << xfip->xfi_fnum; + } + + max_fields = fnum; + + for (xfip = fields, fnum = 0; xfip->xfi_ftype; xfip++) { + switch (xfip->xfi_ftype) { + case XO_ROLE_NEWLINE: /* Don't get numbered */ + case XO_ROLE_TEXT: + case XO_ROLE_EBRACE: + case 'G': + continue; + } + + if (xfip->xfi_fnum != 0) + continue; + + /* Find the next unassigned field */ + for (fnum++; bits & (one << fnum); fnum++) + continue; + + if (fnum > max_fields) + break; + + xfip->xfi_fnum = fnum; /* Mark the field number */ + bits |= one << fnum; /* Mark it used */ + } +} + +/* + * The format string uses field numbers, so we need to whiffle through it + * and make sure everything's sane and lovely. + */ +static int +xo_parse_field_numbers (xo_handle_t *xop, const char *fmt, + xo_field_info_t *fields, unsigned num_fields) +{ + xo_field_info_t *xfip; + unsigned field, fnum; + uint64_t bits = 0; + const uint64_t one = 1; /* Avoid 1ULL */ + + for (xfip = fields, field = 0; field < num_fields; xfip++, field++) { + /* Fields default to 1:1 with natural position */ + if (xfip->xfi_fnum == 0) + xfip->xfi_fnum = field + 1; + else if (xfip->xfi_fnum > num_fields) { + xo_failure(xop, "field number exceeds number of fields: '%s'", fmt); + return -1; + } + + fnum = xfip->xfi_fnum - 1; /* Move to zero origin */ + if (fnum < 64) { /* Only test what fits */ + if (bits & (one << fnum)) { + xo_failure(xop, "field number %u reused: '%s'", + xfip->xfi_fnum, fmt); + return -1; + } + bits |= one << fnum; + } + } + + return 0; +} + +static int +xo_parse_fields (xo_handle_t *xop, xo_field_info_t *fields, + unsigned num_fields, const char *fmt) +{ + const char *cp, *sp, *ep, *basep; + unsigned field = 0; + xo_field_info_t *xfip = fields; + unsigned seen_fnum = 0; + + for (cp = fmt; *cp && field < num_fields; field++, xfip++) { + xfip->xfi_start = cp; + + if (*cp == '\n') { + xfip->xfi_ftype = XO_ROLE_NEWLINE; + xfip->xfi_len = 1; + cp += 1; + continue; + } + + if (*cp != '{') { + /* Normal text */ + for (sp = cp; *sp; sp++) { + if (*sp == '{' || *sp == '\n') + break; + } + + xfip->xfi_ftype = XO_ROLE_TEXT; + xfip->xfi_content = cp; + xfip->xfi_clen = sp - cp; + xfip->xfi_next = sp; + + cp = sp; + continue; + } + + if (cp[1] == '{') { /* Start of {{escaped braces}} */ + xfip->xfi_start = cp + 1; /* Start at second brace */ + xfip->xfi_ftype = XO_ROLE_EBRACE; + + cp += 2; /* Skip over _both_ characters */ + for (sp = cp; *sp; sp++) { + if (*sp == '}' && sp[1] == '}') + break; + } + if (*sp == '\0') { + xo_failure(xop, "missing closing '}}': '%s'", + xo_printable(fmt)); + return -1; + } + + xfip->xfi_len = sp - xfip->xfi_start + 1; + + /* Move along the string, but don't run off the end */ + if (*sp == '}' && sp[1] == '}') /* Paranoid; must be true */ + sp += 2; + + cp = sp; + xfip->xfi_next = cp; + continue; + } + + /* We are looking at the start of a field definition */ + xfip->xfi_start = basep = cp + 1; + + const char *format = NULL; + ssize_t flen = 0; + + /* Looking at roles and modifiers */ + sp = xo_parse_roles(xop, fmt, basep, xfip); + if (sp == NULL) { + /* xo_failure has already been called */ + return -1; + } + + if (xfip->xfi_fnum) + seen_fnum = 1; + + /* Looking at content */ + if (*sp == ':') { + for (ep = ++sp; *sp; sp++) { + if (*sp == '}' || *sp == '/') + break; + if (*sp == '\\') { + if (sp[1] == '\0') { + xo_failure(xop, "backslash at the end of string"); + return -1; + } + sp += 1; + continue; + } + } + if (ep != sp) { + xfip->xfi_clen = sp - ep; + xfip->xfi_content = ep; + } + } else { + xo_failure(xop, "missing content (':'): '%s'", xo_printable(fmt)); + return -1; + } + + /* Looking at main (display) format */ + if (*sp == '/') { + for (ep = ++sp; *sp; sp++) { + if (*sp == '}' || *sp == '/') + break; + if (*sp == '\\') { + if (sp[1] == '\0') { + xo_failure(xop, "backslash at the end of string"); + return -1; + } + sp += 1; + continue; + } + } + flen = sp - ep; + format = ep; + } + + /* Looking at encoding format */ + if (*sp == '/') { + for (ep = ++sp; *sp; sp++) { + if (*sp == '}') + break; + } + + xfip->xfi_encoding = ep; + xfip->xfi_elen = sp - ep; + } + + if (*sp != '}') { + xo_failure(xop, "missing closing '}': %s", xo_printable(fmt)); + return -1; + } + + xfip->xfi_len = sp - xfip->xfi_start; + xfip->xfi_next = ++sp; + + /* If we have content, then we have a default format */ + if (xfip->xfi_clen || format || (xfip->xfi_flags & XFF_ARGUMENT)) { + if (format) { + xfip->xfi_format = format; + xfip->xfi_flen = flen; + } else if (xo_role_wants_default_format(xfip->xfi_ftype)) { + xfip->xfi_format = xo_default_format; + xfip->xfi_flen = 2; + } + } + + cp = sp; + } + + int rc = 0; + + /* + * If we saw a field number on at least one field, then we need + * to enforce some rules and/or guidelines. + */ + if (seen_fnum) + rc = xo_parse_field_numbers(xop, fmt, fields, field); + + return rc; +} + +/* + * We are passed a pointer to a format string just past the "{G:}" + * field. We build a simplified version of the format string. + */ +static int +xo_gettext_simplify_format (xo_handle_t *xop UNUSED, + xo_buffer_t *xbp, + xo_field_info_t *fields, + int this_field, + const char *fmt UNUSED, + xo_simplify_field_func_t field_cb) +{ + unsigned ftype; + xo_xff_flags_t flags; + int field = this_field + 1; + xo_field_info_t *xfip; + char ch; + + for (xfip = &fields[field]; xfip->xfi_ftype; xfip++, field++) { + ftype = xfip->xfi_ftype; + flags = xfip->xfi_flags; + + if ((flags & XFF_GT_FIELD) && xfip->xfi_content && ftype != 'V') { + if (field_cb) + field_cb(xfip->xfi_content, xfip->xfi_clen, + (flags & XFF_GT_PLURAL) ? 1 : 0); + } + + switch (ftype) { + case 'G': + /* Ignore gettext roles */ + break; + + case XO_ROLE_NEWLINE: + xo_buf_append(xbp, "\n", 1); + break; + + case XO_ROLE_EBRACE: + xo_buf_append(xbp, "{", 1); + xo_buf_append(xbp, xfip->xfi_content, xfip->xfi_clen); + xo_buf_append(xbp, "}", 1); + break; + + case XO_ROLE_TEXT: + xo_buf_append(xbp, xfip->xfi_content, xfip->xfi_clen); + break; + + default: + xo_buf_append(xbp, "{", 1); + if (ftype != 'V') { + ch = ftype; + xo_buf_append(xbp, &ch, 1); + } + + unsigned fnum = xfip->xfi_fnum ?: 0; + if (fnum) { + char num[12]; + /* Field numbers are origin 1, not 0, following printf(3) */ + snprintf(num, sizeof(num), "%u", fnum); + xo_buf_append(xbp, num, strlen(num)); + } + + xo_buf_append(xbp, ":", 1); + xo_buf_append(xbp, xfip->xfi_content, xfip->xfi_clen); + xo_buf_append(xbp, "}", 1); + } + } + + xo_buf_append(xbp, "", 1); + return 0; +} + +void +xo_dump_fields (xo_field_info_t *); /* Fake prototype for debug function */ +void +xo_dump_fields (xo_field_info_t *fields) +{ + xo_field_info_t *xfip; + + for (xfip = fields; xfip->xfi_ftype; xfip++) { + printf("%lu(%u): %lx [%c/%u] [%.*s] [%.*s] [%.*s]\n", + (unsigned long) (xfip - fields), xfip->xfi_fnum, + (unsigned long) xfip->xfi_flags, + isprint((int) xfip->xfi_ftype) ? xfip->xfi_ftype : ' ', + xfip->xfi_ftype, + (int) xfip->xfi_clen, xfip->xfi_content ?: "", + (int) xfip->xfi_flen, xfip->xfi_format ?: "", + (int) xfip->xfi_elen, xfip->xfi_encoding ?: ""); + } +} + +#ifdef HAVE_GETTEXT +/* + * Find the field that matches the given field number + */ +static xo_field_info_t * +xo_gettext_find_field (xo_field_info_t *fields, unsigned fnum) +{ + xo_field_info_t *xfip; + + for (xfip = fields; xfip->xfi_ftype; xfip++) + if (xfip->xfi_fnum == fnum) + return xfip; + + return NULL; +} + +/* + * At this point, we need to consider if the fields have been reordered, + * such as "The {:adjective} {:noun}" to "La {:noun} {:adjective}". + * + * We need to rewrite the new_fields using the old fields order, + * so that we can render the message using the arguments as they + * appear on the stack. It's a lot of work, but we don't really + * want to (eventually) fall into the standard printf code which + * means using the arguments straight (and in order) from the + * varargs we were originally passed. + */ +static void +xo_gettext_rewrite_fields (xo_handle_t *xop UNUSED, + xo_field_info_t *fields, unsigned max_fields) +{ + xo_field_info_t tmp[max_fields]; + bzero(tmp, max_fields * sizeof(tmp[0])); + + unsigned fnum = 0; + xo_field_info_t *newp, *outp, *zp; + for (newp = fields, outp = tmp; newp->xfi_ftype; newp++, outp++) { + switch (newp->xfi_ftype) { + case XO_ROLE_NEWLINE: /* Don't get numbered */ + case XO_ROLE_TEXT: + case XO_ROLE_EBRACE: + case 'G': + *outp = *newp; + outp->xfi_renum = 0; + continue; + } + + zp = xo_gettext_find_field(fields, ++fnum); + if (zp == NULL) { /* Should not occur */ + *outp = *newp; + outp->xfi_renum = 0; + continue; + } + + *outp = *zp; + outp->xfi_renum = newp->xfi_fnum; + } + + memcpy(fields, tmp, max_fields * sizeof(tmp[0])); +} + +/* + * We've got two lists of fields, the old list from the original + * format string and the new one from the parsed gettext reply. The + * new list has the localized words, where the old list has the + * formatting information. We need to combine them into a single list + * (the new list). + * + * If the list needs to be reordered, then we've got more serious work + * to do. + */ +static int +xo_gettext_combine_formats (xo_handle_t *xop, const char *fmt UNUSED, + const char *gtfmt, xo_field_info_t *old_fields, + xo_field_info_t *new_fields, unsigned new_max_fields, + int *reorderedp) +{ + int reordered = 0; + xo_field_info_t *newp, *oldp, *startp = old_fields; + + xo_gettext_finish_numbering_fields(xop, fmt, old_fields); + + for (newp = new_fields; newp->xfi_ftype; newp++) { + switch (newp->xfi_ftype) { + case XO_ROLE_NEWLINE: + case XO_ROLE_TEXT: + case XO_ROLE_EBRACE: + continue; + + case 'V': + for (oldp = startp; oldp->xfi_ftype; oldp++) { + if (oldp->xfi_ftype != 'V') + continue; + if (newp->xfi_clen != oldp->xfi_clen + || strncmp(newp->xfi_content, oldp->xfi_content, + oldp->xfi_clen) != 0) { + reordered = 1; + continue; + } + startp = oldp + 1; + break; + } + + /* Didn't find it on the first pass (starting from start) */ + if (oldp->xfi_ftype == 0) { + for (oldp = old_fields; oldp < startp; oldp++) { + if (oldp->xfi_ftype != 'V') + continue; + if (newp->xfi_clen != oldp->xfi_clen) + continue; + if (strncmp(newp->xfi_content, oldp->xfi_content, + oldp->xfi_clen) != 0) + continue; + reordered = 1; + break; + } + if (oldp == startp) { + /* Field not found */ + xo_failure(xop, "post-gettext format can't find field " + "'%.*s' in format '%s'", + newp->xfi_clen, newp->xfi_content, + xo_printable(gtfmt)); + return -1; + } + } + break; + + default: + /* + * Other fields don't have names for us to use, so if + * the types aren't the same, then we'll have to assume + * the original field is a match. + */ + for (oldp = startp; oldp->xfi_ftype; oldp++) { + if (oldp->xfi_ftype == 'V') /* Can't go past these */ + break; + if (oldp->xfi_ftype == newp->xfi_ftype) + goto copy_it; /* Assumably we have a match */ + } + continue; + } + + /* + * Found a match; copy over appropriate fields + */ + copy_it: + newp->xfi_flags = oldp->xfi_flags; + newp->xfi_fnum = oldp->xfi_fnum; + newp->xfi_format = oldp->xfi_format; + newp->xfi_flen = oldp->xfi_flen; + newp->xfi_encoding = oldp->xfi_encoding; + newp->xfi_elen = oldp->xfi_elen; + } + + *reorderedp = reordered; + if (reordered) { + xo_gettext_finish_numbering_fields(xop, fmt, new_fields); + xo_gettext_rewrite_fields(xop, new_fields, new_max_fields); + } + + return 0; +} + +/* + * We don't want to make gettext() calls here with a complete format + * string, since that means changing a flag would mean a + * labor-intensive re-translation expense. Instead we build a + * simplified form with a reduced level of detail, perform a lookup on + * that string and then re-insert the formating info. + * + * So something like: + * xo_emit("{G:}close {:fd/%ld} returned {g:error/%m} {:test/%6.6s}\n", ...) + * would have a lookup string of: + * "close {:fd} returned {:error} {:test}\n" + * + * We also need to handling reordering of fields, where the gettext() + * reply string uses fields in a different order than the original + * format string: + * "cluse-a {:fd} retoorned {:test}. Bork {:error} Bork. Bork.\n" + * If we have to reorder fields within the message, then things get + * complicated. See xo_gettext_rewrite_fields. + * + * Summary: i18n aighn't cheap. + */ +static const char * +xo_gettext_build_format (xo_handle_t *xop, + xo_field_info_t *fields, int this_field, + const char *fmt, char **new_fmtp) +{ + if (xo_style_is_encoding(xop)) + goto bail; + + xo_buffer_t xb; + xo_buf_init(&xb); + + if (xo_gettext_simplify_format(xop, &xb, fields, + this_field, fmt, NULL)) + goto bail2; + + const char *gtfmt = xo_dgettext(xop, xb.xb_bufp); + if (gtfmt == NULL || gtfmt == fmt || xo_streq(gtfmt, fmt)) + goto bail2; + + char *new_fmt = xo_strndup(gtfmt, -1); + if (new_fmt == NULL) + goto bail2; + + xo_buf_cleanup(&xb); + + *new_fmtp = new_fmt; + return new_fmt; + + bail2: + xo_buf_cleanup(&xb); + bail: + *new_fmtp = NULL; + return fmt; +} + +static void +xo_gettext_rebuild_content (xo_handle_t *xop, xo_field_info_t *fields, + ssize_t *fstart, unsigned min_fstart, + ssize_t *fend, unsigned max_fend) +{ + xo_field_info_t *xfip; + char *buf; + ssize_t base = fstart[min_fstart]; + ssize_t blen = fend[max_fend] - base; + xo_buffer_t *xbp = &xop->xo_data; + + if (blen == 0) + return; + + buf = xo_realloc(NULL, blen); + if (buf == NULL) + return; + + memcpy(buf, xbp->xb_bufp + fstart[min_fstart], blen); /* Copy our data */ + + unsigned field = min_fstart, len, fnum; + ssize_t soff, doff = base; + xo_field_info_t *zp; + + /* + * Be aware there are two competing views of "field number": we + * want the user to thing in terms of "The {1:size}" where {G:}, + * newlines, escaped braces, and text don't have numbers. But is + * also the internal view, where we have an array of + * xo_field_info_t and every field have an index. fnum, fstart[] + * and fend[] are the latter, but xfi_renum is the former. + */ + for (xfip = fields + field; xfip->xfi_ftype; xfip++, field++) { + fnum = field; + if (xfip->xfi_renum) { + zp = xo_gettext_find_field(fields, xfip->xfi_renum); + fnum = zp ? zp - fields : field; + } + + soff = fstart[fnum]; + len = fend[fnum] - soff; + + if (len > 0) { + soff -= base; + memcpy(xbp->xb_bufp + doff, buf + soff, len); + doff += len; + } + } + + xo_free(buf); +} +#else /* HAVE_GETTEXT */ +static const char * +xo_gettext_build_format (xo_handle_t *xop UNUSED, + xo_field_info_t *fields UNUSED, + int this_field UNUSED, + const char *fmt UNUSED, char **new_fmtp) +{ + *new_fmtp = NULL; + return fmt; +} + +static int +xo_gettext_combine_formats (xo_handle_t *xop UNUSED, const char *fmt UNUSED, + const char *gtfmt UNUSED, + xo_field_info_t *old_fields UNUSED, + xo_field_info_t *new_fields UNUSED, + unsigned new_max_fields UNUSED, + int *reorderedp UNUSED) +{ + return -1; +} + +static void +xo_gettext_rebuild_content (xo_handle_t *xop UNUSED, + xo_field_info_t *fields UNUSED, + ssize_t *fstart UNUSED, unsigned min_fstart UNUSED, + ssize_t *fend UNUSED, unsigned max_fend UNUSED) +{ + return; +} +#endif /* HAVE_GETTEXT */ + +/* + * Emit a set of fields. This is really the core of libxo. + */ +static ssize_t +xo_do_emit_fields (xo_handle_t *xop, xo_field_info_t *fields, + unsigned max_fields, const char *fmt) +{ + int gettext_inuse = 0; + int gettext_changed = 0; + int gettext_reordered = 0; + unsigned ftype; + xo_xff_flags_t flags; + xo_field_info_t *new_fields = NULL; + xo_field_info_t *xfip; + unsigned field; + ssize_t rc = 0; + + int flush = XOF_ISSET(xop, XOF_FLUSH); + int flush_line = XOF_ISSET(xop, XOF_FLUSH_LINE); + char *new_fmt = NULL; + + if (XOIF_ISSET(xop, XOIF_REORDER) || xo_style(xop) == XO_STYLE_ENCODER) + flush_line = 0; + + /* + * Some overhead for gettext; if the fields in the msgstr returned + * by gettext are reordered, then we need to record start and end + * for each field. We'll go ahead and render the fields in the + * normal order, but later we can then reconstruct the reordered + * fields using these fstart/fend values. + */ + unsigned flimit = max_fields * 2; /* Pessimistic limit */ + unsigned min_fstart = flimit - 1; + unsigned max_fend = 0; /* Highest recorded fend[] entry */ + ssize_t fstart[flimit]; + bzero(fstart, flimit * sizeof(fstart[0])); + ssize_t fend[flimit]; + bzero(fend, flimit * sizeof(fend[0])); + + for (xfip = fields, field = 0; field < max_fields && xfip->xfi_ftype; + xfip++, field++) { + ftype = xfip->xfi_ftype; + flags = xfip->xfi_flags; + + /* Record field start offset */ + if (gettext_reordered) { + fstart[field] = xo_buf_offset(&xop->xo_data); + if (min_fstart > field) + min_fstart = field; + } + + const char *content = xfip->xfi_content; + ssize_t clen = xfip->xfi_clen; + + if (flags & XFF_ARGUMENT) { + /* + * Argument flag means the content isn't given in the descriptor, + * but as a UTF-8 string ('const char *') argument in xo_vap. + */ + content = va_arg(xop->xo_vap, char *); + clen = content ? strlen(content) : 0; + } + + if (ftype == XO_ROLE_NEWLINE) { + xo_line_close(xop); + if (flush_line && xo_flush_h(xop) < 0) + return -1; + goto bottom; + + } else if (ftype == XO_ROLE_EBRACE) { + xo_format_text(xop, xfip->xfi_start, xfip->xfi_len); + goto bottom; + + } else if (ftype == XO_ROLE_TEXT) { + /* Normal text */ + xo_format_text(xop, xfip->xfi_content, xfip->xfi_clen); + goto bottom; + } + + /* + * Notes and units need the 'w' flag handled before the content. + */ + if (ftype == 'N' || ftype == 'U') { + if (flags & XFF_WS) { + xo_format_content(xop, "padding", NULL, " ", 1, + NULL, 0, flags); + flags &= ~XFF_WS; /* Prevent later handling of this flag */ + } + } + + if (ftype == 'V') + xo_format_value(xop, content, clen, NULL, 0, + xfip->xfi_format, xfip->xfi_flen, + xfip->xfi_encoding, xfip->xfi_elen, flags); + else if (ftype == '[') + xo_anchor_start(xop, xfip, content, clen); + else if (ftype == ']') + xo_anchor_stop(xop, xfip, content, clen); + else if (ftype == 'C') + xo_format_colors(xop, xfip, content, clen); + + else if (ftype == 'G') { + /* + * A {G:domain} field; disect the domain name and translate + * the remaining portion of the input string. If the user + * didn't put the {G:} at the start of the format string, then + * assumably they just want us to translate the rest of it. + * Since gettext returns strings in a static buffer, we make + * a copy in new_fmt. + */ + xo_set_gettext_domain(xop, xfip, content, clen); + + if (!gettext_inuse) { /* Only translate once */ + gettext_inuse = 1; + if (new_fmt) { + xo_free(new_fmt); + new_fmt = NULL; + } + + xo_gettext_build_format(xop, fields, field, + xfip->xfi_next, &new_fmt); + if (new_fmt) { + gettext_changed = 1; + + unsigned new_max_fields = xo_count_fields(xop, new_fmt); + + if (++new_max_fields < max_fields) + new_max_fields = max_fields; + + /* Leave a blank slot at the beginning */ + ssize_t sz = (new_max_fields + 1) * sizeof(xo_field_info_t); + new_fields = alloca(sz); + bzero(new_fields, sz); + + if (!xo_parse_fields(xop, new_fields + 1, + new_max_fields, new_fmt)) { + gettext_reordered = 0; + + if (!xo_gettext_combine_formats(xop, fmt, new_fmt, + fields, new_fields + 1, + new_max_fields, &gettext_reordered)) { + + if (gettext_reordered) { + if (XOF_ISSET(xop, XOF_LOG_GETTEXT)) + xo_failure(xop, "gettext finds reordered " + "fields in '%s' and '%s'", + xo_printable(fmt), + xo_printable(new_fmt)); + flush_line = 0; /* Must keep at content */ + XOIF_SET(xop, XOIF_REORDER); + } + + field = -1; /* Will be incremented at top of loop */ + xfip = new_fields; + max_fields = new_max_fields; + } + } + } + } + continue; + + } else if (clen || xfip->xfi_format) { + + const char *class_name = xo_class_name(ftype); + if (class_name) + xo_format_content(xop, class_name, xo_tag_name(ftype), + content, clen, + xfip->xfi_format, xfip->xfi_flen, flags); + else if (ftype == 'T') + xo_format_title(xop, xfip, content, clen); + else if (ftype == 'U') + xo_format_units(xop, xfip, content, clen); + else + xo_failure(xop, "unknown field type: '%c'", ftype); + } + + if (flags & XFF_COLON) + xo_format_content(xop, "decoration", NULL, ":", 1, NULL, 0, 0); + + if (flags & XFF_WS) + xo_format_content(xop, "padding", NULL, " ", 1, NULL, 0, 0); + + bottom: + /* Record the end-of-field offset */ + if (gettext_reordered) { + fend[field] = xo_buf_offset(&xop->xo_data); + max_fend = field; + } + } + + if (gettext_changed && gettext_reordered) { + /* Final step: rebuild the content using the rendered fields */ + xo_gettext_rebuild_content(xop, new_fields + 1, fstart, min_fstart, + fend, max_fend); + } + + XOIF_CLEAR(xop, XOIF_REORDER); + + /* + * If we've got enough data, flush it. + */ + if (xo_buf_offset(&xop->xo_data) > XO_BUF_HIGH_WATER) + flush = 1; + + /* If we don't have an anchor, write the text out */ + if (flush && !XOIF_ISSET(xop, XOIF_ANCHOR)) { + if (xo_flush_h(xop) < 0) + rc = -1; + } + + if (new_fmt) + xo_free(new_fmt); + + /* + * We've carried the gettext domainname inside our handle just for + * convenience, but we need to ensure it doesn't survive across + * xo_emit calls. + */ + if (xop->xo_gt_domain) { + xo_free(xop->xo_gt_domain); + xop->xo_gt_domain = NULL; + } + + return (rc < 0) ? rc : xop->xo_columns; +} + +/* + * Parse and emit a set of fields + */ +static int +xo_do_emit (xo_handle_t *xop, xo_emit_flags_t flags, const char *fmt) +{ + xop->xo_columns = 0; /* Always reset it */ + xop->xo_errno = errno; /* Save for "%m" */ + + if (fmt == NULL) + return 0; + + unsigned max_fields; + xo_field_info_t *fields = NULL; + + /* Adjust XOEF_RETAIN based on global flags */ + if (XOF_ISSET(xop, XOF_RETAIN_ALL)) + flags |= XOEF_RETAIN; + if (XOF_ISSET(xop, XOF_RETAIN_NONE)) + flags &= ~XOEF_RETAIN; + + /* + * Check for 'retain' flag, telling us to retain the field + * information. If we've already saved it, then we can avoid + * re-parsing the format string. + */ + if (!(flags & XOEF_RETAIN) + || xo_retain_find(fmt, &fields, &max_fields) != 0 + || fields == NULL) { + + /* Nothing retained; parse the format string */ + max_fields = xo_count_fields(xop, fmt); + fields = alloca(max_fields * sizeof(fields[0])); + bzero(fields, max_fields * sizeof(fields[0])); + + if (xo_parse_fields(xop, fields, max_fields, fmt)) + return -1; /* Warning already displayed */ + + if (flags & XOEF_RETAIN) { + /* Retain the info */ + xo_retain_add(fmt, fields, max_fields); + } + } + + return xo_do_emit_fields(xop, fields, max_fields, fmt); +} + +/* + * Rebuild a format string in a gettext-friendly format. This function + * is exposed to tools can perform this function. See xo(1). + */ +char * +xo_simplify_format (xo_handle_t *xop, const char *fmt, int with_numbers, + xo_simplify_field_func_t field_cb) +{ + xop = xo_default(xop); + + xop->xo_columns = 0; /* Always reset it */ + xop->xo_errno = errno; /* Save for "%m" */ + + unsigned max_fields = xo_count_fields(xop, fmt); + xo_field_info_t fields[max_fields]; + + bzero(fields, max_fields * sizeof(fields[0])); + + if (xo_parse_fields(xop, fields, max_fields, fmt)) + return NULL; /* Warning already displayed */ + + xo_buffer_t xb; + xo_buf_init(&xb); + + if (with_numbers) + xo_gettext_finish_numbering_fields(xop, fmt, fields); + + if (xo_gettext_simplify_format(xop, &xb, fields, -1, fmt, field_cb)) + return NULL; + + return xb.xb_bufp; +} + +xo_ssize_t +xo_emit_hv (xo_handle_t *xop, const char *fmt, va_list vap) +{ + ssize_t rc; + + xop = xo_default(xop); + va_copy(xop->xo_vap, vap); + rc = xo_do_emit(xop, 0, fmt); + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + + return rc; +} + +xo_ssize_t +xo_emit_h (xo_handle_t *xop, const char *fmt, ...) +{ + ssize_t rc; + + xop = xo_default(xop); + va_start(xop->xo_vap, fmt); + rc = xo_do_emit(xop, 0, fmt); + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + + return rc; +} + +xo_ssize_t +xo_emit (const char *fmt, ...) +{ + xo_handle_t *xop = xo_default(NULL); + ssize_t rc; + + va_start(xop->xo_vap, fmt); + rc = xo_do_emit(xop, 0, fmt); + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + + return rc; +} + +xo_ssize_t +xo_emit_hvf (xo_handle_t *xop, xo_emit_flags_t flags, + const char *fmt, va_list vap) +{ + ssize_t rc; + + xop = xo_default(xop); + va_copy(xop->xo_vap, vap); + rc = xo_do_emit(xop, flags, fmt); + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + + return rc; +} + +xo_ssize_t +xo_emit_hf (xo_handle_t *xop, xo_emit_flags_t flags, const char *fmt, ...) +{ + ssize_t rc; + + xop = xo_default(xop); + va_start(xop->xo_vap, fmt); + rc = xo_do_emit(xop, flags, fmt); + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + + return rc; +} + +xo_ssize_t +xo_emit_f (xo_emit_flags_t flags, const char *fmt, ...) +{ + xo_handle_t *xop = xo_default(NULL); + ssize_t rc; + + va_start(xop->xo_vap, fmt); + rc = xo_do_emit(xop, flags, fmt); + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + + return rc; +} + +/* + * Emit a single field by providing the info information typically provided + * inside the field description (role, modifiers, and formats). This is + * a convenience function to avoid callers using snprintf to build field + * descriptions. + */ +xo_ssize_t +xo_emit_field_hv (xo_handle_t *xop, const char *rolmod, const char *contents, + const char *fmt, const char *efmt, + va_list vap) +{ + ssize_t rc; + + xop = xo_default(xop); + + if (rolmod == NULL) + rolmod = "V"; + + xo_field_info_t xfi; + + bzero(&xfi, sizeof(xfi)); + + const char *cp; + cp = xo_parse_roles(xop, rolmod, rolmod, &xfi); + if (cp == NULL) + return -1; + + xfi.xfi_start = fmt; + xfi.xfi_content = contents; + xfi.xfi_format = fmt; + xfi.xfi_encoding = efmt; + xfi.xfi_clen = contents ? strlen(contents) : 0; + xfi.xfi_flen = fmt ? strlen(fmt) : 0; + xfi.xfi_elen = efmt ? strlen(efmt) : 0; + + /* If we have content, then we have a default format */ + if (contents && fmt == NULL + && xo_role_wants_default_format(xfi.xfi_ftype)) { + xfi.xfi_format = xo_default_format; + xfi.xfi_flen = 2; + } + + va_copy(xop->xo_vap, vap); + + rc = xo_do_emit_fields(xop, &xfi, 1, fmt ?: contents ?: "field"); + + va_end(xop->xo_vap); + + return rc; +} + +xo_ssize_t +xo_emit_field_h (xo_handle_t *xop, const char *rolmod, const char *contents, + const char *fmt, const char *efmt, ...) +{ + ssize_t rc; + va_list vap; + + va_start(vap, efmt); + rc = xo_emit_field_hv(xop, rolmod, contents, fmt, efmt, vap); + va_end(vap); + + return rc; +} + +xo_ssize_t +xo_emit_field (const char *rolmod, const char *contents, + const char *fmt, const char *efmt, ...) +{ + ssize_t rc; + va_list vap; + + va_start(vap, efmt); + rc = xo_emit_field_hv(NULL, rolmod, contents, fmt, efmt, vap); + va_end(vap); + + return rc; +} + +xo_ssize_t +xo_attr_hv (xo_handle_t *xop, const char *name, const char *fmt, va_list vap) +{ + const ssize_t extra = 5; /* space, equals, quote, quote, and nul */ + xop = xo_default(xop); + + ssize_t rc = 0; + ssize_t nlen = strlen(name); + xo_buffer_t *xbp = &xop->xo_attrs; + ssize_t name_offset, value_offset; + + switch (xo_style(xop)) { + case XO_STYLE_XML: + if (!xo_buf_has_room(xbp, nlen + extra)) + return -1; + + *xbp->xb_curp++ = ' '; + memcpy(xbp->xb_curp, name, nlen); + xbp->xb_curp += nlen; + *xbp->xb_curp++ = '='; + *xbp->xb_curp++ = '"'; + + rc = xo_vsnprintf(xop, xbp, fmt, vap); + + if (rc >= 0) { + rc = xo_escape_xml(xbp, rc, 1); + xbp->xb_curp += rc; + } + + if (!xo_buf_has_room(xbp, 2)) + return -1; + + *xbp->xb_curp++ = '"'; + *xbp->xb_curp = '\0'; + + rc += nlen + extra; + break; + + case XO_STYLE_ENCODER: + name_offset = xo_buf_offset(xbp); + xo_buf_append(xbp, name, nlen); + xo_buf_append(xbp, "", 1); + + value_offset = xo_buf_offset(xbp); + rc = xo_vsnprintf(xop, xbp, fmt, vap); + if (rc >= 0) { + xbp->xb_curp += rc; + *xbp->xb_curp = '\0'; + rc = xo_encoder_handle(xop, XO_OP_ATTRIBUTE, + xo_buf_data(xbp, name_offset), + xo_buf_data(xbp, value_offset), 0); + } + } + + return rc; +} + +xo_ssize_t +xo_attr_h (xo_handle_t *xop, const char *name, const char *fmt, ...) +{ + ssize_t rc; + va_list vap; + + va_start(vap, fmt); + rc = xo_attr_hv(xop, name, fmt, vap); + va_end(vap); + + return rc; +} + +xo_ssize_t +xo_attr (const char *name, const char *fmt, ...) +{ + ssize_t rc; + va_list vap; + + va_start(vap, fmt); + rc = xo_attr_hv(NULL, name, fmt, vap); + va_end(vap); + + return rc; +} + +static void +xo_depth_change (xo_handle_t *xop, const char *name, + int delta, int indent, xo_state_t state, xo_xsf_flags_t flags) +{ + if (xo_style(xop) == XO_STYLE_HTML || xo_style(xop) == XO_STYLE_TEXT) + indent = 0; + + if (XOF_ISSET(xop, XOF_DTRT)) + flags |= XSF_DTRT; + + if (delta >= 0) { /* Push operation */ + if (xo_depth_check(xop, xop->xo_depth + delta)) + return; + + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth + delta]; + xsp->xs_flags = flags; + xsp->xs_state = state; + xo_stack_set_flags(xop); + + if (name == NULL) + name = XO_FAILURE_NAME; + + xsp->xs_name = xo_strndup(name, -1); + + } else { /* Pop operation */ + if (xop->xo_depth == 0) { + if (!XOF_ISSET(xop, XOF_IGNORE_CLOSE)) + xo_failure(xop, "close with empty stack: '%s'", name); + return; + } + + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + if (XOF_ISSET(xop, XOF_WARN)) { + const char *top = xsp->xs_name; + if (top != NULL && name != NULL && !xo_streq(name, top)) { + xo_failure(xop, "incorrect close: '%s' .vs. '%s'", + name, top); + return; + } + if ((xsp->xs_flags & XSF_LIST) != (flags & XSF_LIST)) { + xo_failure(xop, "list close on list confict: '%s'", + name); + return; + } + if ((xsp->xs_flags & XSF_INSTANCE) != (flags & XSF_INSTANCE)) { + xo_failure(xop, "list close on instance confict: '%s'", + name); + return; + } + } + + if (xsp->xs_name) { + xo_free(xsp->xs_name); + xsp->xs_name = NULL; + } + if (xsp->xs_keys) { + xo_free(xsp->xs_keys); + xsp->xs_keys = NULL; + } + } + + xop->xo_depth += delta; /* Record new depth */ + xop->xo_indent += indent; +} + +void +xo_set_depth (xo_handle_t *xop, int depth) +{ + xop = xo_default(xop); + + if (xo_depth_check(xop, depth)) + return; + + xop->xo_depth += depth; + xop->xo_indent += depth; + + /* + * Handling the "top wrapper" for JSON is a bit of a pain. Here + * we need to detect that the depth has been changed to set the + * "XOIF_TOP_EMITTED" flag correctly. + */ + if (xop->xo_style == XO_STYLE_JSON + && !XOF_ISSET(xop, XOF_NO_TOP) && xop->xo_depth > 0) + XOIF_SET(xop, XOIF_TOP_EMITTED); +} + +static xo_xsf_flags_t +xo_stack_flags (xo_xof_flags_t xflags) +{ + if (xflags & XOF_DTRT) + return XSF_DTRT; + return 0; +} + +static void +xo_emit_top (xo_handle_t *xop, const char *ppn) +{ + xo_printf(xop, "%*s{%s", xo_indent(xop), "", ppn); + XOIF_SET(xop, XOIF_TOP_EMITTED); + + if (xop->xo_version) { + xo_printf(xop, "%*s\"__version\": \"%s\", %s", + xo_indent(xop), "", xop->xo_version, ppn); + xo_free(xop->xo_version); + xop->xo_version = NULL; + } +} + +static ssize_t +xo_do_open_container (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + ssize_t rc = 0; + const char *ppn = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + const char *pre_nl = ""; + + if (name == NULL) { + xo_failure(xop, "NULL passed for container name"); + name = XO_FAILURE_NAME; + } + + const char *leader = xo_xml_leader(xop, name); + flags |= xop->xo_flags; /* Pick up handle flags */ + + switch (xo_style(xop)) { + case XO_STYLE_XML: + rc = xo_printf(xop, "%*s<%s%s", xo_indent(xop), "", leader, name); + + if (xop->xo_attrs.xb_curp != xop->xo_attrs.xb_bufp) { + rc += xop->xo_attrs.xb_curp - xop->xo_attrs.xb_bufp; + xo_data_append(xop, xop->xo_attrs.xb_bufp, + xop->xo_attrs.xb_curp - xop->xo_attrs.xb_bufp); + xop->xo_attrs.xb_curp = xop->xo_attrs.xb_bufp; + } + + rc += xo_printf(xop, ">%s", ppn); + break; + + case XO_STYLE_JSON: + xo_stack_set_flags(xop); + + if (!XOF_ISSET(xop, XOF_NO_TOP) + && !XOIF_ISSET(xop, XOIF_TOP_EMITTED)) + xo_emit_top(xop, ppn); + + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? ",\n" : ", "; + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + + /* If we need underscores, make a local copy and doctor it */ + const char *new_name = name; + if (XOF_ISSET(xop, XOF_UNDERSCORES)) { + size_t len = strlen(name); + const char *old_name = name; + char *buf, *cp, *ep; + + buf = alloca(len + 1); + for (cp = buf, ep = buf + len + 1; cp < ep; cp++, old_name++) + *cp = (*old_name == '-') ? '_' : *old_name; + new_name = buf; + } + + rc = xo_printf(xop, "%s%*s\"%s\": {%s", + pre_nl, xo_indent(xop), "", new_name, ppn); + break; + + case XO_STYLE_SDPARAMS: + break; + + case XO_STYLE_ENCODER: + rc = xo_encoder_handle(xop, XO_OP_OPEN_CONTAINER, name, NULL, flags); + break; + } + + xo_depth_change(xop, name, 1, 1, XSS_OPEN_CONTAINER, + xo_stack_flags(flags)); + + return rc; +} + +xo_ssize_t +xo_open_container_hf (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + return xo_transition(xop, flags, name, XSS_OPEN_CONTAINER); +} + +xo_ssize_t +xo_open_container_h (xo_handle_t *xop, const char *name) +{ + return xo_open_container_hf(xop, 0, name); +} + +xo_ssize_t +xo_open_container (const char *name) +{ + return xo_open_container_hf(NULL, 0, name); +} + +xo_ssize_t +xo_open_container_hd (xo_handle_t *xop, const char *name) +{ + return xo_open_container_hf(xop, XOF_DTRT, name); +} + +xo_ssize_t +xo_open_container_d (const char *name) +{ + return xo_open_container_hf(NULL, XOF_DTRT, name); +} + +static int +xo_do_close_container (xo_handle_t *xop, const char *name) +{ + xop = xo_default(xop); + + ssize_t rc = 0; + const char *ppn = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + const char *pre_nl = ""; + + if (name == NULL) { + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + + name = xsp->xs_name; + if (name) { + ssize_t len = strlen(name) + 1; + /* We need to make a local copy; xo_depth_change will free it */ + char *cp = alloca(len); + memcpy(cp, name, len); + name = cp; + } else if (!(xsp->xs_flags & XSF_DTRT)) { + xo_failure(xop, "missing name without 'dtrt' mode"); + name = XO_FAILURE_NAME; + } + } + + const char *leader = xo_xml_leader(xop, name); + + switch (xo_style(xop)) { + case XO_STYLE_XML: + xo_depth_change(xop, name, -1, -1, XSS_CLOSE_CONTAINER, 0); + rc = xo_printf(xop, "%*s</%s%s>%s", xo_indent(xop), "", leader, name, ppn); + break; + + case XO_STYLE_JSON: + xo_stack_set_flags(xop); + + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + ppn = ""; + + xo_depth_change(xop, name, -1, -1, XSS_CLOSE_CONTAINER, 0); + rc = xo_printf(xop, "%s%*s}%s", pre_nl, xo_indent(xop), "", ppn); + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + break; + + case XO_STYLE_HTML: + case XO_STYLE_TEXT: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_CONTAINER, 0); + break; + + case XO_STYLE_SDPARAMS: + break; + + case XO_STYLE_ENCODER: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_CONTAINER, 0); + rc = xo_encoder_handle(xop, XO_OP_CLOSE_CONTAINER, name, NULL, 0); + break; + } + + return rc; +} + +xo_ssize_t +xo_close_container_h (xo_handle_t *xop, const char *name) +{ + return xo_transition(xop, 0, name, XSS_CLOSE_CONTAINER); +} + +xo_ssize_t +xo_close_container (const char *name) +{ + return xo_close_container_h(NULL, name); +} + +xo_ssize_t +xo_close_container_hd (xo_handle_t *xop) +{ + return xo_close_container_h(xop, NULL); +} + +xo_ssize_t +xo_close_container_d (void) +{ + return xo_close_container_h(NULL, NULL); +} + +static int +xo_do_open_list (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + ssize_t rc = 0; + int indent = 0; + + xop = xo_default(xop); + + const char *ppn = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + const char *pre_nl = ""; + + switch (xo_style(xop)) { + case XO_STYLE_JSON: + + indent = 1; + if (!XOF_ISSET(xop, XOF_NO_TOP) + && !XOIF_ISSET(xop, XOIF_TOP_EMITTED)) + xo_emit_top(xop, ppn); + + if (name == NULL) { + xo_failure(xop, "NULL passed for list name"); + name = XO_FAILURE_NAME; + } + + xo_stack_set_flags(xop); + + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? ",\n" : ", "; + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + + /* If we need underscores, make a local copy and doctor it */ + const char *new_name = name; + if (XOF_ISSET(xop, XOF_UNDERSCORES)) { + size_t len = strlen(name); + const char *old_name = name; + char *buf, *cp, *ep; + + buf = alloca(len + 1); + for (cp = buf, ep = buf + len + 1; cp < ep; cp++, old_name++) + *cp = (*old_name == '-') ? '_' : *old_name; + new_name = buf; + } + + rc = xo_printf(xop, "%s%*s\"%s\": [%s", + pre_nl, xo_indent(xop), "", new_name, ppn); + break; + + case XO_STYLE_ENCODER: + rc = xo_encoder_handle(xop, XO_OP_OPEN_LIST, name, NULL, flags); + break; + } + + xo_depth_change(xop, name, 1, indent, XSS_OPEN_LIST, + XSF_LIST | xo_stack_flags(flags)); + + return rc; +} + +xo_ssize_t +xo_open_list_hf (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + return xo_transition(xop, flags, name, XSS_OPEN_LIST); +} + +xo_ssize_t +xo_open_list_h (xo_handle_t *xop, const char *name) +{ + return xo_open_list_hf(xop, 0, name); +} + +xo_ssize_t +xo_open_list (const char *name) +{ + return xo_open_list_hf(NULL, 0, name); +} + +xo_ssize_t +xo_open_list_hd (xo_handle_t *xop, const char *name) +{ + return xo_open_list_hf(xop, XOF_DTRT, name); +} + +xo_ssize_t +xo_open_list_d (const char *name) +{ + return xo_open_list_hf(NULL, XOF_DTRT, name); +} + +static int +xo_do_close_list (xo_handle_t *xop, const char *name) +{ + ssize_t rc = 0; + const char *pre_nl = ""; + + if (name == NULL) { + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + + name = xsp->xs_name; + if (name) { + ssize_t len = strlen(name) + 1; + /* We need to make a local copy; xo_depth_change will free it */ + char *cp = alloca(len); + memcpy(cp, name, len); + name = cp; + } else if (!(xsp->xs_flags & XSF_DTRT)) { + xo_failure(xop, "missing name without 'dtrt' mode"); + name = XO_FAILURE_NAME; + } + } + + switch (xo_style(xop)) { + case XO_STYLE_JSON: + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + + xo_depth_change(xop, name, -1, -1, XSS_CLOSE_LIST, XSF_LIST); + rc = xo_printf(xop, "%s%*s]", pre_nl, xo_indent(xop), ""); + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + break; + + case XO_STYLE_ENCODER: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_LIST, XSF_LIST); + rc = xo_encoder_handle(xop, XO_OP_CLOSE_LIST, name, NULL, 0); + break; + + default: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_LIST, XSF_LIST); + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + break; + } + + return rc; +} + +xo_ssize_t +xo_close_list_h (xo_handle_t *xop, const char *name) +{ + return xo_transition(xop, 0, name, XSS_CLOSE_LIST); +} + +xo_ssize_t +xo_close_list (const char *name) +{ + return xo_close_list_h(NULL, name); +} + +xo_ssize_t +xo_close_list_hd (xo_handle_t *xop) +{ + return xo_close_list_h(xop, NULL); +} + +xo_ssize_t +xo_close_list_d (void) +{ + return xo_close_list_h(NULL, NULL); +} + +static int +xo_do_open_leaf_list (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + ssize_t rc = 0; + int indent = 0; + + xop = xo_default(xop); + + const char *ppn = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + const char *pre_nl = ""; + + switch (xo_style(xop)) { + case XO_STYLE_JSON: + indent = 1; + + if (!XOF_ISSET(xop, XOF_NO_TOP)) { + if (!XOIF_ISSET(xop, XOIF_TOP_EMITTED)) { + xo_printf(xop, "%*s{%s", xo_indent(xop), "", ppn); + XOIF_SET(xop, XOIF_TOP_EMITTED); + } + } + + if (name == NULL) { + xo_failure(xop, "NULL passed for list name"); + name = XO_FAILURE_NAME; + } + + xo_stack_set_flags(xop); + + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? ",\n" : ", "; + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + + rc = xo_printf(xop, "%s%*s\"%s\": [%s", + pre_nl, xo_indent(xop), "", name, ppn); + break; + + case XO_STYLE_ENCODER: + rc = xo_encoder_handle(xop, XO_OP_OPEN_LEAF_LIST, name, NULL, flags); + break; + } + + xo_depth_change(xop, name, 1, indent, XSS_OPEN_LEAF_LIST, + XSF_LIST | xo_stack_flags(flags)); + + return rc; +} + +static int +xo_do_close_leaf_list (xo_handle_t *xop, const char *name) +{ + ssize_t rc = 0; + const char *pre_nl = ""; + + if (name == NULL) { + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + + name = xsp->xs_name; + if (name) { + ssize_t len = strlen(name) + 1; + /* We need to make a local copy; xo_depth_change will free it */ + char *cp = alloca(len); + memcpy(cp, name, len); + name = cp; + } else if (!(xsp->xs_flags & XSF_DTRT)) { + xo_failure(xop, "missing name without 'dtrt' mode"); + name = XO_FAILURE_NAME; + } + } + + switch (xo_style(xop)) { + case XO_STYLE_JSON: + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + + xo_depth_change(xop, name, -1, -1, XSS_CLOSE_LEAF_LIST, XSF_LIST); + rc = xo_printf(xop, "%s%*s]", pre_nl, xo_indent(xop), ""); + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + break; + + case XO_STYLE_ENCODER: + rc = xo_encoder_handle(xop, XO_OP_CLOSE_LEAF_LIST, name, NULL, 0); + /* FALLTHRU */ + + default: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_LEAF_LIST, XSF_LIST); + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + break; + } + + return rc; +} + +static int +xo_do_open_instance (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + xop = xo_default(xop); + + ssize_t rc = 0; + const char *ppn = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + const char *pre_nl = ""; + + if (name == NULL) { + xo_failure(xop, "NULL passed for instance name"); + name = XO_FAILURE_NAME; + } + + const char *leader = xo_xml_leader(xop, name); + flags |= xop->xo_flags; + + switch (xo_style(xop)) { + case XO_STYLE_XML: + rc = xo_printf(xop, "%*s<%s%s", xo_indent(xop), "", leader, name); + + if (xop->xo_attrs.xb_curp != xop->xo_attrs.xb_bufp) { + rc += xop->xo_attrs.xb_curp - xop->xo_attrs.xb_bufp; + xo_data_append(xop, xop->xo_attrs.xb_bufp, + xop->xo_attrs.xb_curp - xop->xo_attrs.xb_bufp); + xop->xo_attrs.xb_curp = xop->xo_attrs.xb_bufp; + } + + rc += xo_printf(xop, ">%s", ppn); + break; + + case XO_STYLE_JSON: + xo_stack_set_flags(xop); + + if (xop->xo_stack[xop->xo_depth].xs_flags & XSF_NOT_FIRST) + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? ",\n" : ", "; + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + + rc = xo_printf(xop, "%s%*s{%s", + pre_nl, xo_indent(xop), "", ppn); + break; + + case XO_STYLE_SDPARAMS: + break; + + case XO_STYLE_ENCODER: + rc = xo_encoder_handle(xop, XO_OP_OPEN_INSTANCE, name, NULL, flags); + break; + } + + xo_depth_change(xop, name, 1, 1, XSS_OPEN_INSTANCE, xo_stack_flags(flags)); + + return rc; +} + +xo_ssize_t +xo_open_instance_hf (xo_handle_t *xop, xo_xof_flags_t flags, const char *name) +{ + return xo_transition(xop, flags, name, XSS_OPEN_INSTANCE); +} + +xo_ssize_t +xo_open_instance_h (xo_handle_t *xop, const char *name) +{ + return xo_open_instance_hf(xop, 0, name); +} + +xo_ssize_t +xo_open_instance (const char *name) +{ + return xo_open_instance_hf(NULL, 0, name); +} + +xo_ssize_t +xo_open_instance_hd (xo_handle_t *xop, const char *name) +{ + return xo_open_instance_hf(xop, XOF_DTRT, name); +} + +xo_ssize_t +xo_open_instance_d (const char *name) +{ + return xo_open_instance_hf(NULL, XOF_DTRT, name); +} + +static int +xo_do_close_instance (xo_handle_t *xop, const char *name) +{ + xop = xo_default(xop); + + ssize_t rc = 0; + const char *ppn = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + const char *pre_nl = ""; + + if (name == NULL) { + xo_stack_t *xsp = &xop->xo_stack[xop->xo_depth]; + + name = xsp->xs_name; + if (name) { + ssize_t len = strlen(name) + 1; + /* We need to make a local copy; xo_depth_change will free it */ + char *cp = alloca(len); + memcpy(cp, name, len); + name = cp; + } else if (!(xsp->xs_flags & XSF_DTRT)) { + xo_failure(xop, "missing name without 'dtrt' mode"); + name = XO_FAILURE_NAME; + } + } + + const char *leader = xo_xml_leader(xop, name); + + switch (xo_style(xop)) { + case XO_STYLE_XML: + xo_depth_change(xop, name, -1, -1, XSS_CLOSE_INSTANCE, 0); + rc = xo_printf(xop, "%*s</%s%s>%s", xo_indent(xop), "", leader, name, ppn); + break; + + case XO_STYLE_JSON: + pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + + xo_depth_change(xop, name, -1, -1, XSS_CLOSE_INSTANCE, 0); + rc = xo_printf(xop, "%s%*s}", pre_nl, xo_indent(xop), ""); + xop->xo_stack[xop->xo_depth].xs_flags |= XSF_NOT_FIRST; + break; + + case XO_STYLE_HTML: + case XO_STYLE_TEXT: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_INSTANCE, 0); + break; + + case XO_STYLE_SDPARAMS: + break; + + case XO_STYLE_ENCODER: + xo_depth_change(xop, name, -1, 0, XSS_CLOSE_INSTANCE, 0); + rc = xo_encoder_handle(xop, XO_OP_CLOSE_INSTANCE, name, NULL, 0); + break; + } + + return rc; +} + +xo_ssize_t +xo_close_instance_h (xo_handle_t *xop, const char *name) +{ + return xo_transition(xop, 0, name, XSS_CLOSE_INSTANCE); +} + +xo_ssize_t +xo_close_instance (const char *name) +{ + return xo_close_instance_h(NULL, name); +} + +xo_ssize_t +xo_close_instance_hd (xo_handle_t *xop) +{ + return xo_close_instance_h(xop, NULL); +} + +xo_ssize_t +xo_close_instance_d (void) +{ + return xo_close_instance_h(NULL, NULL); +} + +static int +xo_do_close_all (xo_handle_t *xop, xo_stack_t *limit) +{ + xo_stack_t *xsp; + ssize_t rc = 0; + xo_xsf_flags_t flags; + + for (xsp = &xop->xo_stack[xop->xo_depth]; xsp >= limit; xsp--) { + switch (xsp->xs_state) { + case XSS_INIT: + /* Nothing */ + rc = 0; + break; + + case XSS_OPEN_CONTAINER: + rc = xo_do_close_container(xop, NULL); + break; + + case XSS_OPEN_LIST: + rc = xo_do_close_list(xop, NULL); + break; + + case XSS_OPEN_INSTANCE: + rc = xo_do_close_instance(xop, NULL); + break; + + case XSS_OPEN_LEAF_LIST: + rc = xo_do_close_leaf_list(xop, NULL); + break; + + case XSS_MARKER: + flags = xsp->xs_flags & XSF_MARKER_FLAGS; + xo_depth_change(xop, xsp->xs_name, -1, 0, XSS_MARKER, 0); + xop->xo_stack[xop->xo_depth].xs_flags |= flags; + rc = 0; + break; + } + + if (rc < 0) + xo_failure(xop, "close %d failed: %d", xsp->xs_state, rc); + } + + return 0; +} + +/* + * This function is responsible for clearing out whatever is needed + * to get to the desired state, if possible. + */ +static int +xo_do_close (xo_handle_t *xop, const char *name, xo_state_t new_state) +{ + xo_stack_t *xsp, *limit = NULL; + ssize_t rc; + xo_state_t need_state = new_state; + + if (new_state == XSS_CLOSE_CONTAINER) + need_state = XSS_OPEN_CONTAINER; + else if (new_state == XSS_CLOSE_LIST) + need_state = XSS_OPEN_LIST; + else if (new_state == XSS_CLOSE_INSTANCE) + need_state = XSS_OPEN_INSTANCE; + else if (new_state == XSS_CLOSE_LEAF_LIST) + need_state = XSS_OPEN_LEAF_LIST; + else if (new_state == XSS_MARKER) + need_state = XSS_MARKER; + else + return 0; /* Unknown or useless new states are ignored */ + + for (xsp = &xop->xo_stack[xop->xo_depth]; xsp > xop->xo_stack; xsp--) { + /* + * Marker's normally stop us from going any further, unless + * we are popping a marker (new_state == XSS_MARKER). + */ + if (xsp->xs_state == XSS_MARKER && need_state != XSS_MARKER) { + if (name) { + xo_failure(xop, "close (xo_%s) fails at marker '%s'; " + "not found '%s'", + xo_state_name(new_state), + xsp->xs_name, name); + return 0; + + } else { + limit = xsp; + xo_failure(xop, "close stops at marker '%s'", xsp->xs_name); + } + break; + } + + if (xsp->xs_state != need_state) + continue; + + if (name && xsp->xs_name && !xo_streq(name, xsp->xs_name)) + continue; + + limit = xsp; + break; + } + + if (limit == NULL) { + xo_failure(xop, "xo_%s can't find match for '%s'", + xo_state_name(new_state), name); + return 0; + } + + rc = xo_do_close_all(xop, limit); + + return rc; +} + +/* + * We are in a given state and need to transition to the new state. + */ +static ssize_t +xo_transition (xo_handle_t *xop, xo_xof_flags_t flags, const char *name, + xo_state_t new_state) +{ + xo_stack_t *xsp; + ssize_t rc = 0; + int old_state, on_marker; + + xop = xo_default(xop); + + xsp = &xop->xo_stack[xop->xo_depth]; + old_state = xsp->xs_state; + on_marker = (old_state == XSS_MARKER); + + /* If there's a marker on top of the stack, we need to find a real state */ + while (old_state == XSS_MARKER) { + if (xsp == xop->xo_stack) + break; + xsp -= 1; + old_state = xsp->xs_state; + } + + /* + * At this point, the list of possible states are: + * XSS_INIT, XSS_OPEN_CONTAINER, XSS_OPEN_LIST, + * XSS_OPEN_INSTANCE, XSS_OPEN_LEAF_LIST, XSS_DISCARDING + */ + switch (XSS_TRANSITION(old_state, new_state)) { + + open_container: + case XSS_TRANSITION(XSS_INIT, XSS_OPEN_CONTAINER): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_OPEN_CONTAINER): + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_OPEN_CONTAINER): + rc = xo_do_open_container(xop, flags, name); + break; + + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_OPEN_CONTAINER): + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_OPEN_CONTAINER): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, NULL); + if (rc >= 0) + goto open_container; + break; + + case XSS_TRANSITION(XSS_INIT, XSS_CLOSE_CONTAINER): + /* This is an exception for "xo --close" */ + rc = xo_do_close_container(xop, name); + break; + + /*close_container:*/ + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_CLOSE_CONTAINER): + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_CLOSE_CONTAINER): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_CLOSE_CONTAINER): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close(xop, name, new_state); + break; + + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_CLOSE_CONTAINER): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, NULL); + if (rc >= 0) + rc = xo_do_close(xop, name, new_state); + break; + + open_list: + case XSS_TRANSITION(XSS_INIT, XSS_OPEN_LIST): + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_OPEN_LIST): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_OPEN_LIST): + rc = xo_do_open_list(xop, flags, name); + break; + + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_OPEN_LIST): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_list(xop, NULL); + if (rc >= 0) + goto open_list; + break; + + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_OPEN_LIST): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, NULL); + if (rc >= 0) + goto open_list; + break; + + /*close_list:*/ + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_CLOSE_LIST): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close(xop, name, new_state); + break; + + case XSS_TRANSITION(XSS_INIT, XSS_CLOSE_LIST): + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_CLOSE_LIST): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_CLOSE_LIST): + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_CLOSE_LIST): + rc = xo_do_close(xop, name, new_state); + break; + + open_instance: + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_OPEN_INSTANCE): + rc = xo_do_open_instance(xop, flags, name); + break; + + case XSS_TRANSITION(XSS_INIT, XSS_OPEN_INSTANCE): + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_OPEN_INSTANCE): + rc = xo_do_open_list(xop, flags, name); + if (rc >= 0) + goto open_instance; + break; + + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_OPEN_INSTANCE): + if (on_marker) { + rc = xo_do_open_list(xop, flags, name); + } else { + rc = xo_do_close_instance(xop, NULL); + } + if (rc >= 0) + goto open_instance; + break; + + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_OPEN_INSTANCE): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, NULL); + if (rc >= 0) + goto open_instance; + break; + + /*close_instance:*/ + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_CLOSE_INSTANCE): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_instance(xop, name); + break; + + case XSS_TRANSITION(XSS_INIT, XSS_CLOSE_INSTANCE): + /* This one makes no sense; ignore it */ + xo_failure(xop, "xo_close_instance ignored when called from " + "initial state ('%s')", name ?: "(unknown)"); + break; + + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_CLOSE_INSTANCE): + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_CLOSE_INSTANCE): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close(xop, name, new_state); + break; + + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_CLOSE_INSTANCE): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, NULL); + if (rc >= 0) + rc = xo_do_close(xop, name, new_state); + break; + + open_leaf_list: + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_OPEN_LEAF_LIST): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_OPEN_LEAF_LIST): + case XSS_TRANSITION(XSS_INIT, XSS_OPEN_LEAF_LIST): + rc = xo_do_open_leaf_list(xop, flags, name); + break; + + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_OPEN_LEAF_LIST): + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_OPEN_LEAF_LIST): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_list(xop, NULL); + if (rc >= 0) + goto open_leaf_list; + break; + + /*close_leaf_list:*/ + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_CLOSE_LEAF_LIST): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, name); + break; + + case XSS_TRANSITION(XSS_INIT, XSS_CLOSE_LEAF_LIST): + /* Makes no sense; ignore */ + xo_failure(xop, "xo_close_leaf_list ignored when called from " + "initial state ('%s')", name ?: "(unknown)"); + break; + + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_CLOSE_LEAF_LIST): + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_CLOSE_LEAF_LIST): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_CLOSE_LEAF_LIST): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close(xop, name, new_state); + break; + + /*emit:*/ + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_EMIT): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_EMIT): + break; + + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_EMIT): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close(xop, NULL, XSS_CLOSE_LIST); + break; + + case XSS_TRANSITION(XSS_INIT, XSS_EMIT): + break; + + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_EMIT): + if (on_marker) + goto marker_prevents_close; + rc = xo_do_close_leaf_list(xop, NULL); + break; + + /*emit_leaf_list:*/ + case XSS_TRANSITION(XSS_INIT, XSS_EMIT_LEAF_LIST): + case XSS_TRANSITION(XSS_OPEN_CONTAINER, XSS_EMIT_LEAF_LIST): + case XSS_TRANSITION(XSS_OPEN_INSTANCE, XSS_EMIT_LEAF_LIST): + rc = xo_do_open_leaf_list(xop, flags, name); + break; + + case XSS_TRANSITION(XSS_OPEN_LEAF_LIST, XSS_EMIT_LEAF_LIST): + break; + + case XSS_TRANSITION(XSS_OPEN_LIST, XSS_EMIT_LEAF_LIST): + /* + * We need to be backward compatible with the pre-xo_open_leaf_list + * API, where both lists and leaf-lists were opened as lists. So + * if we find an open list that hasn't had anything written to it, + * we'll accept it. + */ + break; + + default: + xo_failure(xop, "unknown transition: (%u -> %u)", + xsp->xs_state, new_state); + } + + /* Handle the flush flag */ + if (rc >= 0 && XOF_ISSET(xop, XOF_FLUSH)) + if (xo_flush_h(xop) < 0) + rc = -1; + + /* We have now official made output */ + XOIF_SET(xop, XOIF_MADE_OUTPUT); + + return rc; + + marker_prevents_close: + xo_failure(xop, "marker '%s' prevents transition from %s to %s", + xop->xo_stack[xop->xo_depth].xs_name, + xo_state_name(old_state), xo_state_name(new_state)); + return -1; +} + +xo_ssize_t +xo_open_marker_h (xo_handle_t *xop, const char *name) +{ + xop = xo_default(xop); + + xo_depth_change(xop, name, 1, 0, XSS_MARKER, + xop->xo_stack[xop->xo_depth].xs_flags & XSF_MARKER_FLAGS); + + return 0; +} + +xo_ssize_t +xo_open_marker (const char *name) +{ + return xo_open_marker_h(NULL, name); +} + +xo_ssize_t +xo_close_marker_h (xo_handle_t *xop, const char *name) +{ + xop = xo_default(xop); + + return xo_do_close(xop, name, XSS_MARKER); +} + +xo_ssize_t +xo_close_marker (const char *name) +{ + return xo_close_marker_h(NULL, name); +} + +/* + * Record custom output functions into the xo handle, allowing + * integration with a variety of output frameworks. + */ +void +xo_set_writer (xo_handle_t *xop, void *opaque, xo_write_func_t write_func, + xo_close_func_t close_func, xo_flush_func_t flush_func) +{ + xop = xo_default(xop); + + xop->xo_opaque = opaque; + xop->xo_write = write_func; + xop->xo_close = close_func; + xop->xo_flush = flush_func; +} + +void +xo_set_allocator (xo_realloc_func_t realloc_func, xo_free_func_t free_func) +{ + xo_realloc = realloc_func; + xo_free = free_func; +} + +xo_ssize_t +xo_flush_h (xo_handle_t *xop) +{ + ssize_t rc; + + xop = xo_default(xop); + + switch (xo_style(xop)) { + case XO_STYLE_ENCODER: + xo_encoder_handle(xop, XO_OP_FLUSH, NULL, NULL, 0); + } + + rc = xo_write(xop); + if (rc >= 0 && xop->xo_flush) + if (xop->xo_flush(xop->xo_opaque) < 0) + return -1; + + return rc; +} + +xo_ssize_t +xo_flush (void) +{ + return xo_flush_h(NULL); +} + +xo_ssize_t +xo_finish_h (xo_handle_t *xop) +{ + const char *open_if_empty = ""; + xop = xo_default(xop); + + if (!XOF_ISSET(xop, XOF_NO_CLOSE)) + xo_do_close_all(xop, xop->xo_stack); + + switch (xo_style(xop)) { + case XO_STYLE_JSON: + if (!XOF_ISSET(xop, XOF_NO_TOP)) { + const char *pre_nl = XOF_ISSET(xop, XOF_PRETTY) ? "\n" : ""; + + if (XOIF_ISSET(xop, XOIF_TOP_EMITTED)) + XOIF_CLEAR(xop, XOIF_TOP_EMITTED); /* Turn off before output */ + else if (!XOIF_ISSET(xop, XOIF_MADE_OUTPUT)) { + open_if_empty = "{ "; + pre_nl = ""; + } + + xo_printf(xop, "%s%*s%s}\n", + pre_nl, xo_indent(xop), "", open_if_empty); + } + break; + + case XO_STYLE_ENCODER: + xo_encoder_handle(xop, XO_OP_FINISH, NULL, NULL, 0); + break; + } + + return xo_flush_h(xop); +} + +xo_ssize_t +xo_finish (void) +{ + return xo_finish_h(NULL); +} + +/* + * xo_finish_atexit is suitable for atexit() calls, to force clear up + * and finalizing output. + */ +void +xo_finish_atexit (void) +{ + (void) xo_finish_h(NULL); +} + +/* + * Generate an error message, such as would be displayed on stderr + */ +void +xo_errorn_hv (xo_handle_t *xop, int need_newline, const char *fmt, va_list vap) +{ + xop = xo_default(xop); + + /* + * If the format string doesn't end with a newline, we pop + * one on ourselves. + */ + if (need_newline) { + ssize_t len = strlen(fmt); + if (len > 0 && fmt[len - 1] != '\n') { + char *newfmt = alloca(len + 2); + memcpy(newfmt, fmt, len); + newfmt[len] = '\n'; + newfmt[len + 1] = '\0'; + fmt = newfmt; + } + } + + switch (xo_style(xop)) { + case XO_STYLE_TEXT: + vfprintf(stderr, fmt, vap); + break; + + case XO_STYLE_HTML: + va_copy(xop->xo_vap, vap); + + xo_buf_append_div(xop, "error", 0, NULL, 0, NULL, 0, + fmt, strlen(fmt), NULL, 0); + + if (XOIF_ISSET(xop, XOIF_DIV_OPEN)) + xo_line_close(xop); + + xo_write(xop); + + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + break; + + case XO_STYLE_XML: + case XO_STYLE_JSON: + va_copy(xop->xo_vap, vap); + + xo_open_container_h(xop, "error"); + xo_format_value(xop, "message", 7, NULL, 0, + fmt, strlen(fmt), NULL, 0, 0); + xo_close_container_h(xop, "error"); + + va_end(xop->xo_vap); + bzero(&xop->xo_vap, sizeof(xop->xo_vap)); + break; + + case XO_STYLE_SDPARAMS: + case XO_STYLE_ENCODER: + break; + } +} + +void +xo_error_h (xo_handle_t *xop, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_errorn_hv(xop, 0, fmt, vap); + va_end(vap); +} + +/* + * Generate an error message, such as would be displayed on stderr + */ +void +xo_error (const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_errorn_hv(NULL, 0, fmt, vap); + va_end(vap); +} + +void +xo_errorn_h (xo_handle_t *xop, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_errorn_hv(xop, 1, fmt, vap); + va_end(vap); +} + +/* + * Generate an error message, such as would be displayed on stderr + */ +void +xo_errorn (const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_errorn_hv(NULL, 1, fmt, vap); + va_end(vap); +} + +/* + * Parse any libxo-specific options from the command line, removing them + * so the main() argument parsing won't see them. We return the new value + * for argc or -1 for error. If an error occurred, the program should + * exit. A suitable error message has already been displayed. + */ +int +xo_parse_args (int argc, char **argv) +{ + static char libxo_opt[] = "--libxo"; + char *cp; + int i, save; + + /* + * If xo_set_program has always been called, we honor that value + */ + if (xo_program == NULL) { + /* Save our program name for xo_err and friends */ + xo_program = argv[0]; + cp = strrchr(xo_program, '/'); + if (cp) + xo_program = ++cp; + else + cp = argv[0]; /* Reset to front of string */ + + /* + * GNU libtool add an annoying ".test" as the program + * extension; we remove it. libtool also adds a "lt-" prefix + * that we cannot remove. + */ + size_t len = strlen(xo_program); + static const char gnu_ext[] = ".test"; + if (len >= sizeof(gnu_ext)) { + cp += len + 1 - sizeof(gnu_ext); + if (xo_streq(cp, gnu_ext)) + *cp = '\0'; + } + } + + xo_handle_t *xop = xo_default(NULL); + + for (save = i = 1; i < argc; i++) { + if (argv[i] == NULL + || strncmp(argv[i], libxo_opt, sizeof(libxo_opt) - 1) != 0) { + if (save != i) + argv[save] = argv[i]; + save += 1; + continue; + } + + cp = argv[i] + sizeof(libxo_opt) - 1; + if (*cp == '\0') { + cp = argv[++i]; + if (cp == NULL) { + xo_warnx("missing libxo option"); + return -1; + } + + if (xo_set_options(xop, cp) < 0) + return -1; + } else if (*cp == ':') { + if (xo_set_options(xop, cp) < 0) + return -1; + + } else if (*cp == '=') { + if (xo_set_options(xop, ++cp) < 0) + return -1; + + } else if (*cp == '-') { + cp += 1; + if (xo_streq(cp, "check")) { + exit(XO_HAS_LIBXO); + + } else { + xo_warnx("unknown libxo option: '%s'", argv[i]); + return -1; + } + } else { + xo_warnx("unknown libxo option: '%s'", argv[i]); + return -1; + } + } + + /* + * We only want to do color output on terminals, but we only want + * to do this if the user has asked for color. + */ + if (XOF_ISSET(xop, XOF_COLOR_ALLOWED) && isatty(1)) + XOF_SET(xop, XOF_COLOR); + + argv[save] = NULL; + return save; +} + +/* + * Debugging function that dumps the current stack of open libxo constructs, + * suitable for calling from the debugger. + */ +void +xo_dump_stack (xo_handle_t *xop) +{ + int i; + xo_stack_t *xsp; + + xop = xo_default(xop); + + fprintf(stderr, "Stack dump:\n"); + + xsp = xop->xo_stack; + for (i = 1, xsp++; i <= xop->xo_depth; i++, xsp++) { + fprintf(stderr, " [%d] %s '%s' [%x]\n", + i, xo_state_name(xsp->xs_state), + xsp->xs_name ?: "--", xsp->xs_flags); + } +} + +/* + * Record the program name used for error messages + */ +void +xo_set_program (const char *name) +{ + xo_program = name; +} + +void +xo_set_version_h (xo_handle_t *xop, const char *version) +{ + xop = xo_default(xop); + + if (version == NULL || strchr(version, '"') != NULL) + return; + + if (!xo_style_is_encoding(xop)) + return; + + switch (xo_style(xop)) { + case XO_STYLE_XML: + /* For XML, we record this as an attribute for the first tag */ + xo_attr_h(xop, "version", "%s", version); + break; + + case XO_STYLE_JSON: + /* + * For JSON, we record the version string in our handle, and emit + * it in xo_emit_top. + */ + xop->xo_version = xo_strndup(version, -1); + break; + + case XO_STYLE_ENCODER: + xo_encoder_handle(xop, XO_OP_VERSION, NULL, version, 0); + break; + } +} + +/* + * Set the version number for the API content being carried through + * the xo handle. + */ +void +xo_set_version (const char *version) +{ + xo_set_version_h(NULL, version); +} + +/* + * Generate a warning. Normally, this is a text message written to + * standard error. If the XOF_WARN_XML flag is set, then we generate + * XMLified content on standard output. + */ +void +xo_emit_warn_hcv (xo_handle_t *xop, int as_warning, int code, + const char *fmt, va_list vap) +{ + xop = xo_default(xop); + + if (fmt == NULL) + return; + + xo_open_marker_h(xop, "xo_emit_warn_hcv"); + xo_open_container_h(xop, as_warning ? "__warning" : "__error"); + + if (xo_program) + xo_emit("{wc:program}", xo_program); + + if (xo_style(xop) == XO_STYLE_XML || xo_style(xop) == XO_STYLE_JSON) { + va_list ap; + xo_handle_t temp; + + bzero(&temp, sizeof(temp)); + temp.xo_style = XO_STYLE_TEXT; + xo_buf_init(&temp.xo_data); + xo_depth_check(&temp, XO_DEPTH); + + va_copy(ap, vap); + (void) xo_emit_hv(&temp, fmt, ap); + va_end(ap); + + xo_buffer_t *src = &temp.xo_data; + xo_format_value(xop, "message", 7, src->xb_bufp, + src->xb_curp - src->xb_bufp, NULL, 0, NULL, 0, 0); + + xo_free(temp.xo_stack); + xo_buf_cleanup(src); + } + + (void) xo_emit_hv(xop, fmt, vap); + + ssize_t len = strlen(fmt); + if (len > 0 && fmt[len - 1] != '\n') { + if (code > 0) { + const char *msg = strerror(code); + if (msg) + xo_emit_h(xop, ": {G:strerror}{g:error/%s}", msg); + } + xo_emit("\n"); + } + + xo_close_marker_h(xop, "xo_emit_warn_hcv"); + xo_flush_h(xop); +} + +void +xo_emit_warn_hc (xo_handle_t *xop, int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_emit_warn_hcv(xop, 1, code, fmt, vap); + va_end(vap); +} + +void +xo_emit_warn_c (int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 1, code, fmt, vap); + va_end(vap); +} + +void +xo_emit_warn (const char *fmt, ...) +{ + int code = errno; + va_list vap; + + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 1, code, fmt, vap); + va_end(vap); +} + +void +xo_emit_warnx (const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 1, -1, fmt, vap); + va_end(vap); +} + +void +xo_emit_err_v (int eval, int code, const char *fmt, va_list vap) +{ + xo_emit_warn_hcv(NULL, 0, code, fmt, vap); + xo_finish(); + exit(eval); +} + +void +xo_emit_err (int eval, const char *fmt, ...) +{ + int code = errno; + va_list vap; + va_start(vap, fmt); + xo_emit_err_v(eval, code, fmt, vap); + /*NOTREACHED*/ +} + +void +xo_emit_errx (int eval, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_emit_err_v(eval, -1, fmt, vap); /* This will exit */ + /*NOTREACHED*/ +} + +void +xo_emit_errc (int eval, int code, const char *fmt, ...) +{ + va_list vap; + + va_start(vap, fmt); + xo_emit_err_v(eval, code, fmt, vap); /* This will exit */ + /*NOTREACHED*/ +} + +/* + * Get the opaque private pointer for an xo handle + */ +void * +xo_get_private (xo_handle_t *xop) +{ + xop = xo_default(xop); + return xop->xo_private; +} + +/* + * Set the opaque private pointer for an xo handle. + */ +void +xo_set_private (xo_handle_t *xop, void *opaque) +{ + xop = xo_default(xop); + xop->xo_private = opaque; +} + +/* + * Get the encoder function + */ +xo_encoder_func_t +xo_get_encoder (xo_handle_t *xop) +{ + xop = xo_default(xop); + return xop->xo_encoder; +} + +/* + * Record an encoder callback function in an xo handle. + */ +void +xo_set_encoder (xo_handle_t *xop, xo_encoder_func_t encoder) +{ + xop = xo_default(xop); + + xop->xo_style = XO_STYLE_ENCODER; + xop->xo_encoder = encoder; +} + +/* + * The xo(1) utility needs to be able to open and close lists and + * instances, but since it's called without "state", we cannot + * rely on the state transitions (in xo_transition) to DTRT, so + * we have a mechanism for external parties to "force" transitions + * that would otherwise be impossible. This is not a general + * mechanism, and is really tailored only for xo(1). + */ +void +xo_explicit_transition (xo_handle_t *xop, xo_state_t new_state, + const char *name, xo_xof_flags_t flags) +{ + xo_xsf_flags_t xsf_flags; + + xop = xo_default(xop); + + switch (new_state) { + + case XSS_OPEN_LIST: + xo_do_open_list(xop, flags, name); + break; + + case XSS_OPEN_INSTANCE: + xo_do_open_instance(xop, flags, name); + break; + + case XSS_CLOSE_INSTANCE: + xo_depth_change(xop, name, 1, 1, XSS_OPEN_INSTANCE, + xo_stack_flags(flags)); + xo_stack_set_flags(xop); + xo_do_close_instance(xop, name); + break; + + case XSS_CLOSE_LIST: + xsf_flags = XOF_ISSET(xop, XOF_NOT_FIRST) ? XSF_NOT_FIRST : 0; + + xo_depth_change(xop, name, 1, 1, XSS_OPEN_LIST, + XSF_LIST | xsf_flags | xo_stack_flags(flags)); + xo_do_close_list(xop, name); + break; + } +} diff --git a/contrib/libxo/libxo/xo.h b/contrib/libxo/libxo/xo.h new file mode 100644 index 000000000000..7f37b469b54e --- /dev/null +++ b/contrib/libxo/libxo/xo.h @@ -0,0 +1,710 @@ +/* + * Copyright (c) 2014-2018, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +/** + * libxo provides a means of generating text, XML, JSON, and HTML output + * using a single set of function calls, maximizing the value of output + * while minimizing the cost/impact on the code. + * + * Full documentation is available in ./doc/libxo.txt or online at: + * http://juniper.github.io/libxo/libxo-manual.html + */ + +#ifndef INCLUDE_XO_H +#define INCLUDE_XO_H + +#include <stdio.h> +#include <sys/types.h> +#include <stdarg.h> +#include <limits.h> +#include <stdlib.h> +#include <errno.h> + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +#ifdef __dead2 +#define NORETURN __dead2 +#else +#define NORETURN +#endif /* __dead2 */ + +/* + * Normally we'd use the HAVE_PRINTFLIKE define triggered by the + * --enable-printflike option to configure, but we don't install + * our internal "xoconfig.h", and I'd rather not. Taking the + * coward's path, we'll turn it on inside a #if that allows + * others to turn it off where needed. Not ideal, but functional. + */ +#if !defined(NO_PRINTFLIKE) +#if defined(__linux) && !defined(__printflike) +#define __printflike(_x, _y) __attribute__((__format__ (__printf__, _x, _y))) +#endif +#define PRINTFLIKE(_x, _y) __printflike(_x, _y) +#else +#define PRINTFLIKE(_x, _y) +#endif /* NO_PRINTFLIKE */ + +/** Formatting types */ +typedef unsigned short xo_style_t; +#define XO_STYLE_TEXT 0 /** Generate text output */ +#define XO_STYLE_XML 1 /** Generate XML output */ +#define XO_STYLE_JSON 2 /** Generate JSON output */ +#define XO_STYLE_HTML 3 /** Generate HTML output */ +#define XO_STYLE_SDPARAMS 4 /* Generate syslog structured data params */ +#define XO_STYLE_ENCODER 5 /* Generate calls to external encoder */ + +/** Flags for libxo */ +typedef unsigned long long xo_xof_flags_t; +#define XOF_BIT(_n) ((xo_xof_flags_t) 1 << (_n)) +#define XOF_CLOSE_FP XOF_BIT(0) /** Close file pointer on xo_close() */ +#define XOF_PRETTY XOF_BIT(1) /** Make 'pretty printed' output */ +#define XOF_LOG_SYSLOG XOF_BIT(2) /** Log (on stderr) our syslog content */ +#define XOF_RESV3 XOF_BIT(3) /* Unused */ + +#define XOF_WARN XOF_BIT(4) /** Generate warnings for broken calls */ +#define XOF_XPATH XOF_BIT(5) /** Emit XPath attributes in HTML */ +#define XOF_INFO XOF_BIT(6) /** Emit additional info fields (HTML) */ +#define XOF_WARN_XML XOF_BIT(7) /** Emit warnings in XML (on stdout) */ + +#define XOF_NO_ENV XOF_BIT(8) /** Don't look at LIBXO_OPTIONS env var */ +#define XOF_NO_VA_ARG XOF_BIT(9) /** Don't advance va_list w/ va_arg() */ +#define XOF_DTRT XOF_BIT(10) /** Enable "do the right thing" mode */ +#define XOF_KEYS XOF_BIT(11) /** Flag 'key' fields for xml and json */ + +#define XOF_IGNORE_CLOSE XOF_BIT(12) /** Ignore errors on close tags */ +#define XOF_NOT_FIRST XOF_BIT(13) /* Not the first item (JSON) */ +#define XOF_NO_LOCALE XOF_BIT(14) /** Don't bother with locale */ +#define XOF_RESV15 XOF_BIT(15) /* Unused */ + +#define XOF_NO_TOP XOF_BIT(16) /** Don't emit the top braces in JSON */ +#define XOF_RESV17 XOF_BIT(17) /* Unused */ +#define XOF_UNITS XOF_BIT(18) /** Encode units in XML */ +#define XOF_RESV19 XOF_BIT(19) /* Unused */ + +#define XOF_UNDERSCORES XOF_BIT(20) /** Replace dashes with underscores (JSON)*/ +#define XOF_COLUMNS XOF_BIT(21) /** xo_emit should return a column count */ +#define XOF_FLUSH XOF_BIT(22) /** Flush after each xo_emit call */ +#define XOF_FLUSH_LINE XOF_BIT(23) /** Flush after each newline */ + +#define XOF_NO_CLOSE XOF_BIT(24) /** xo_finish won't close open elements */ +#define XOF_COLOR_ALLOWED XOF_BIT(25) /** Allow color/effects to be enabled */ +#define XOF_COLOR XOF_BIT(26) /** Enable color and effects */ +#define XOF_NO_HUMANIZE XOF_BIT(27) /** Block the {h:} modifier */ + +#define XOF_LOG_GETTEXT XOF_BIT(28) /** Log (stderr) gettext lookup strings */ +#define XOF_UTF8 XOF_BIT(29) /** Force text output to be UTF8 */ +#define XOF_RETAIN_ALL XOF_BIT(30) /** Force use of XOEF_RETAIN */ +#define XOF_RETAIN_NONE XOF_BIT(31) /** Prevent use of XOEF_RETAIN */ + +#define XOF_COLOR_MAP XOF_BIT(32) /** Color map has been initialized */ +#define XOF_CONTINUATION XOF_BIT(33) /** Continuation of previous line */ + +typedef unsigned xo_emit_flags_t; /* Flags to xo_emit() and friends */ +#define XOEF_RETAIN (1<<0) /* Retain parsed formatting information */ + +/* + * The xo_info_t structure provides a mapping between names and + * additional data emitted via HTML. + */ +typedef struct xo_info_s { + const char *xi_name; /* Name of the element */ + const char *xi_type; /* Type of field */ + const char *xi_help; /* Description of field */ +} xo_info_t; + +#define XO_INFO_NULL NULL, NULL, NULL /* Use '{ XO_INFO_NULL }' to end lists */ + +struct xo_handle_s; /* Opaque structure forward */ +typedef struct xo_handle_s xo_handle_t; /* Handle for XO output */ + +/* + * Early versions of the API used "int" instead of "size_t" for buffer + * sizes. We want to fix this but allow for backwards compatibility + * where needed. + */ +#ifdef XO_USE_INT_RETURN_CODES +typedef int xo_ssize_t; /* Buffer size */ +#else /* XO_USE_INT_RETURN_CODES */ +typedef ssize_t xo_ssize_t; /* Buffer size */ +#endif /* XO_USE_INT_RETURN_CODES */ + +typedef xo_ssize_t (*xo_write_func_t)(void *, const char *); +typedef void (*xo_close_func_t)(void *); +typedef int (*xo_flush_func_t)(void *); +typedef void *(*xo_realloc_func_t)(void *, size_t); +typedef void (*xo_free_func_t)(void *); + +/* + * The formatter function mirrors "vsnprintf", with an additional argument + * of the xo handle. The caller should return the number of bytes _needed_ + * to fit the data, even if this exceeds 'len'. + */ +typedef xo_ssize_t (*xo_formatter_t)(xo_handle_t *, char *, xo_ssize_t, + const char *, va_list); +typedef void (*xo_checkpointer_t)(xo_handle_t *, va_list, int); + +xo_handle_t * +xo_create (xo_style_t style, xo_xof_flags_t flags); + +xo_handle_t * +xo_create_to_file (FILE *fp, xo_style_t style, xo_xof_flags_t flags); + +void +xo_destroy (xo_handle_t *xop); + +void +xo_set_writer (xo_handle_t *xop, void *opaque, xo_write_func_t write_func, + xo_close_func_t close_func, xo_flush_func_t flush_func); + +void +xo_set_allocator (xo_realloc_func_t realloc_func, xo_free_func_t free_func); + +void +xo_set_style (xo_handle_t *xop, xo_style_t style); + +xo_style_t +xo_get_style (xo_handle_t *xop); + +int +xo_set_style_name (xo_handle_t *xop, const char *style); + +int +xo_set_options (xo_handle_t *xop, const char *input); + +xo_xof_flags_t +xo_get_flags (xo_handle_t *xop); + +void +xo_set_flags (xo_handle_t *xop, xo_xof_flags_t flags); + +void +xo_clear_flags (xo_handle_t *xop, xo_xof_flags_t flags); + +int +xo_set_file_h (xo_handle_t *xop, FILE *fp); + +int +xo_set_file (FILE *fp); + +void +xo_set_info (xo_handle_t *xop, xo_info_t *infop, int count); + +void +xo_set_formatter (xo_handle_t *xop, xo_formatter_t func, xo_checkpointer_t); + +void +xo_set_depth (xo_handle_t *xop, int depth); + +xo_ssize_t +xo_emit_hv (xo_handle_t *xop, const char *fmt, va_list vap); + +xo_ssize_t +xo_emit_h (xo_handle_t *xop, const char *fmt, ...); + +xo_ssize_t +xo_emit (const char *fmt, ...); + +xo_ssize_t +xo_emit_hvf (xo_handle_t *xop, xo_emit_flags_t flags, + const char *fmt, va_list vap); + +xo_ssize_t +xo_emit_hf (xo_handle_t *xop, xo_emit_flags_t flags, const char *fmt, ...); + +xo_ssize_t +xo_emit_f (xo_emit_flags_t flags, const char *fmt, ...); + +PRINTFLIKE(2, 0) +static inline xo_ssize_t +xo_emit_hvp (xo_handle_t *xop, const char *fmt, va_list vap) +{ + return xo_emit_hv(xop, fmt, vap); +} + +PRINTFLIKE(2, 3) +static inline xo_ssize_t +xo_emit_hp (xo_handle_t *xop, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_ssize_t rc = xo_emit_hv(xop, fmt, vap); + va_end(vap); + return rc; +} + +PRINTFLIKE(1, 2) +static inline xo_ssize_t +xo_emit_p (const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_ssize_t rc = xo_emit_hv(NULL, fmt, vap); + va_end(vap); + return rc; +} + +PRINTFLIKE(3, 0) +static inline xo_ssize_t +xo_emit_hvfp (xo_handle_t *xop, xo_emit_flags_t flags, + const char *fmt, va_list vap) +{ + return xo_emit_hvf(xop, flags, fmt, vap); +} + +PRINTFLIKE(3, 4) +static inline xo_ssize_t +xo_emit_hfp (xo_handle_t *xop, xo_emit_flags_t flags, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_ssize_t rc = xo_emit_hvf(xop, flags, fmt, vap); + va_end(vap); + return rc; +} + +PRINTFLIKE(2, 3) +static inline xo_ssize_t +xo_emit_fp (xo_emit_flags_t flags, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_ssize_t rc = xo_emit_hvf(NULL, flags, fmt, vap); + va_end(vap); + return rc; +} + +xo_ssize_t +xo_open_container_hf (xo_handle_t *xop, xo_xof_flags_t flags, const char *name); + +xo_ssize_t +xo_open_container_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_container (const char *name); + +xo_ssize_t +xo_open_container_hd (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_container_d (const char *name); + +xo_ssize_t +xo_close_container_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_close_container (const char *name); + +xo_ssize_t +xo_close_container_hd (xo_handle_t *xop); + +xo_ssize_t +xo_close_container_d (void); + +xo_ssize_t +xo_open_list_hf (xo_handle_t *xop, xo_xof_flags_t flags, const char *name); + +xo_ssize_t +xo_open_list_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_list (const char *name); + +xo_ssize_t +xo_open_list_hd (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_list_d (const char *name); + +xo_ssize_t +xo_close_list_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_close_list (const char *name); + +xo_ssize_t +xo_close_list_hd (xo_handle_t *xop); + +xo_ssize_t +xo_close_list_d (void); + +xo_ssize_t +xo_open_instance_hf (xo_handle_t *xop, xo_xof_flags_t flags, const char *name); + +xo_ssize_t +xo_open_instance_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_instance (const char *name); + +xo_ssize_t +xo_open_instance_hd (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_instance_d (const char *name); + +xo_ssize_t +xo_close_instance_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_close_instance (const char *name); + +xo_ssize_t +xo_close_instance_hd (xo_handle_t *xop); + +xo_ssize_t +xo_close_instance_d (void); + +xo_ssize_t +xo_open_marker_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_open_marker (const char *name); + +xo_ssize_t +xo_close_marker_h (xo_handle_t *xop, const char *name); + +xo_ssize_t +xo_close_marker (const char *name); + +xo_ssize_t +xo_attr_h (xo_handle_t *xop, const char *name, const char *fmt, ...); + +xo_ssize_t +xo_attr_hv (xo_handle_t *xop, const char *name, const char *fmt, va_list vap); + +xo_ssize_t +xo_attr (const char *name, const char *fmt, ...); + +void +xo_error_hv (xo_handle_t *xop, const char *fmt, va_list vap); + +void +xo_error_h (xo_handle_t *xop, const char *fmt, ...); + +void +xo_error (const char *fmt, ...); + +void +xo_errorn_hv (xo_handle_t *xop, int need_newline, const char *fmt, va_list vap); + +void +xo_errorn_h (xo_handle_t *xop, const char *fmt, ...); + +void +xo_errorn (const char *fmt, ...); + +xo_ssize_t +xo_flush_h (xo_handle_t *xop); + +xo_ssize_t +xo_flush (void); + +xo_ssize_t +xo_finish_h (xo_handle_t *xop); + +xo_ssize_t +xo_finish (void); + +void +xo_finish_atexit (void); + +void +xo_set_leading_xpath (xo_handle_t *xop, const char *path); + +void +xo_warn_hc (xo_handle_t *xop, int code, const char *fmt, ...) PRINTFLIKE(3, 4); + +void +xo_warn_c (int code, const char *fmt, ...) PRINTFLIKE(2, 3); + +void +xo_warn (const char *fmt, ...) PRINTFLIKE(1, 2); + +void +xo_warnx (const char *fmt, ...) PRINTFLIKE(1, 2); + +void +xo_err (int eval, const char *fmt, ...) NORETURN PRINTFLIKE(2, 3); + +void +xo_errx (int eval, const char *fmt, ...) NORETURN PRINTFLIKE(2, 3); + +void +xo_errc (int eval, int code, const char *fmt, ...) NORETURN PRINTFLIKE(3, 4); + +void +xo_message_hcv (xo_handle_t *xop, int code, const char *fmt, va_list vap) PRINTFLIKE(3, 0); + +void +xo_message_hc (xo_handle_t *xop, int code, const char *fmt, ...) PRINTFLIKE(3, 4); + +void +xo_message_c (int code, const char *fmt, ...) PRINTFLIKE(2, 3); + +void +xo_message_e (const char *fmt, ...) PRINTFLIKE(1, 2); + +void +xo_message (const char *fmt, ...) PRINTFLIKE(1, 2); + +void +xo_emit_warn_hcv (xo_handle_t *xop, int as_warning, int code, + const char *fmt, va_list vap); + +void +xo_emit_warn_hc (xo_handle_t *xop, int code, const char *fmt, ...); + +void +xo_emit_warn_c (int code, const char *fmt, ...); + +void +xo_emit_warn (const char *fmt, ...); + +void +xo_emit_warnx (const char *fmt, ...); + +void +xo_emit_err (int eval, const char *fmt, ...) NORETURN; + +void +xo_emit_errx (int eval, const char *fmt, ...) NORETURN; + +void +xo_emit_errc (int eval, int code, const char *fmt, ...) NORETURN; + +PRINTFLIKE(4, 0) +static inline void +xo_emit_warn_hcvp (xo_handle_t *xop, int as_warning, int code, + const char *fmt, va_list vap) +{ + xo_emit_warn_hcv(xop, as_warning, code, fmt, vap); +} + +PRINTFLIKE(3, 4) +static inline void +xo_emit_warn_hcp (xo_handle_t *xop, int code, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(xop, 1, code, fmt, vap); + va_end(vap); +} + +PRINTFLIKE(2, 3) +static inline void +xo_emit_warn_cp (int code, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 1, code, fmt, vap); + va_end(vap); +} + +PRINTFLIKE(1, 2) +static inline void +xo_emit_warn_p (const char *fmt, ...) +{ + int code = errno; + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 1, code, fmt, vap); + va_end(vap); +} + +PRINTFLIKE(1, 2) +static inline void +xo_emit_warnx_p (const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 1, -1, fmt, vap); + va_end(vap); +} + +NORETURN PRINTFLIKE(2, 3) +static inline void +xo_emit_err_p (int eval, const char *fmt, ...) +{ + int code = errno; + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 0, code, fmt, vap); + va_end(vap); + + exit(eval); +} + +PRINTFLIKE(2, 3) +static inline void +xo_emit_errx_p (int eval, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 0, -1, fmt, vap); + va_end(vap); + exit(eval); +} + +PRINTFLIKE(3, 4) +static inline void +xo_emit_errc_p (int eval, int code, const char *fmt, ...) +{ + va_list vap; + va_start(vap, fmt); + xo_emit_warn_hcv(NULL, 0, code, fmt, vap); + va_end(vap); + exit(eval); +} + +void +xo_emit_err_v (int eval, int code, const char *fmt, va_list vap) NORETURN PRINTFLIKE(3, 0); + +void +xo_no_setlocale (void); + +/** + * @brief Lift libxo-specific arguments from a set of arguments + * + * libxo-enable programs typically use command line options to enable + * all the nifty-cool libxo features. xo_parse_args() makes this simple + * by pre-processing the command line arguments given to main(), handling + * and removing the libxo-specific ones, meaning anything starting with + * "--libxo". A full description of these arguments is in the base + * documentation. + * @param[in] argc Number of arguments (ala #main()) + * @param[in] argc Array of argument strings (ala #main()) + * @return New number of arguments, or -1 for failure. + */ +int +xo_parse_args (int argc, char **argv); + +/** + * This is the "magic" number returned by libxo-supporting commands + * when passed the equally magic "--libxo-check" option. If you + * return this, we can (unsafely) assume that since you know the magic + * handshake, you'll happily handle future --libxo options and not do + * something violent like reboot the box or create another hole in the + * ozone layer. + */ +#define XO_HAS_LIBXO 121 + +/** + * externs for libxo's version number strings + */ +extern const char xo_version[]; /** Base version triple string */ +extern const char xo_version_extra[]; /** Extra version magic content */ + +/** + * @brief Dump the internal stack of a libxo handle. + * + * This diagnostic function is something I will ask you to call from + * your program when you write to tell me libxo has gone bat-stink + * crazy and has discarded your list or container or content. Output + * content will be what we lovingly call "developer entertainment". + * @param[in] xop A valid libxo handle, or NULL for the default handle + */ +void +xo_dump_stack (xo_handle_t *xop); + +/** + * @brief Recode the name of the program, suitable for error output. + * + * libxo will record the given name for use while generating error + * messages. The contents are not copied, so the value must continue + * to point to a valid memory location. This allows the caller to change + * the value, but requires the caller to manage the memory. Typically + * this is called with argv[0] from main(). + * @param[in] name The name of the current application program + */ +void +xo_set_program (const char *name); + +/** + * @brief Add a version string to the output, where possible. + * + * Adds a version number to the output, suitable for tracking + * changes in the content. This is only important for the "encoding" + * format styles (XML and JSON) and allows a user of the data to + * discern which version of the data model is in use. + * @param[in] version The version number, encoded as a string + */ +void +xo_set_version (const char *version); + +/** + * #xo_set_version with a handle. + * @param[in] xop A valid libxo handle, or NULL for the default handle + * @param[in] version The version number, encoded as a string + */ +void +xo_set_version_h (xo_handle_t *xop, const char *version); + +void +xo_open_log (const char *ident, int logopt, int facility); + +void +xo_close_log (void); + +int +xo_set_logmask (int maskpri); + +void +xo_set_unit_test_mode (int value); + +void +xo_syslog (int priority, const char *name, const char *message, ...); + +void +xo_vsyslog (int priority, const char *name, const char *message, va_list args); + +typedef void (*xo_syslog_open_t)(void); +typedef void (*xo_syslog_send_t)(const char *full_msg, + const char *v0_hdr, const char *text_only); +typedef void (*xo_syslog_close_t)(void); + +void +xo_set_syslog_handler (xo_syslog_open_t open_func, xo_syslog_send_t send_func, + xo_syslog_close_t close_func); + +void +xo_set_syslog_enterprise_id (unsigned short eid); + +typedef void (*xo_simplify_field_func_t)(const char *, unsigned, int); + +char * +xo_simplify_format (xo_handle_t *xop, const char *fmt, int with_numbers, + xo_simplify_field_func_t field_cb); + +xo_ssize_t +xo_emit_field_hv (xo_handle_t *xop, const char *rolmod, const char *contents, + const char *fmt, const char *efmt, + va_list vap); + +xo_ssize_t +xo_emit_field_h (xo_handle_t *xop, const char *rolmod, const char *contents, + const char *fmt, const char *efmt, ...); + +xo_ssize_t +xo_emit_field (const char *rolmod, const char *contents, + const char *fmt, const char *efmt, ...); + +void +xo_retain_clear_all (void); + +void +xo_retain_clear (const char *fmt); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* INCLUDE_XO_H */ diff --git a/contrib/libxo/libxo/xo_attr.3 b/contrib/libxo/libxo/xo_attr.3 new file mode 100644 index 000000000000..4f1465b1ffde --- /dev/null +++ b/contrib/libxo/libxo/xo_attr.3 @@ -0,0 +1,70 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd July, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_attr , xo_attr_h , xo_attr_hv +.Nd Add attribute name/value pairs to formatted output +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_attr "const char *name" "const char *fmt" "..." +.Ft xo_ssize_t +.Fn xo_attr_h "xo_handle_t *handle" "const char *name, const char *fmt" "..." +.Ft xo_ssize_t +.Fn xo_attr_hv "xo_handle_t *handle" "const char *name" "const char *fmt" "va_list vap" +.Sh DESCRIPTION +The +.Fn xo_attr +function emits attributes for the XML output style. The attribute +value is recorded in the +.Fa handle +and is attached to the next field that is emitted via a +.Xr xo_emit 3 +call. +.Pp +The +.Fa name +parameter give the name of the attribute to be encoded. The +.Fa fmt +parameter gives a printf-style format string used to format the +value of the attribute using any remaining arguments, or the +.Fa vap +parameter as passed to +.Fn xo_attr_hv . +.Bd -literal -offset indent + EXAMPLE: + xo_attr("seconds", "%ld", (unsigned long) login_time); + struct tm *tmp = localtime(login_time); + strftime(buf, sizeof(buf), "%R", tmp); + xo_emit("Logged in at {:login-time}\\n", buf); + XML: + <login-time seconds="1408336270">00:14</login-time> +.Ed +.Pp +Since attributes are only emitted in XML, their use should be limited +to meta-data and additional or redundant representations of data +already emitted in other form. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_buf.h b/contrib/libxo/libxo/xo_buf.h new file mode 100644 index 000000000000..c97f722959c5 --- /dev/null +++ b/contrib/libxo/libxo/xo_buf.h @@ -0,0 +1,163 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, August 2015 + */ + +/* + * This file is an _internal_ part of the libxo plumbing, not suitable + * for external use. It is not considered part of the libxo API and + * will not be a stable part of that API. Mine, not your's, dude... + * The real hope is that something like this will become a standard part + * of libc and I can kill this off. + */ + +#ifndef XO_BUF_H +#define XO_BUF_H + +#define XO_BUFSIZ (8*1024) /* Initial buffer size */ +#define XO_BUF_HIGH_WATER (XO_BUFSIZ - 512) /* When to auto-flush */ +/* + * xo_buffer_t: a memory buffer that can be grown as needed. We + * use them for building format strings and output data. + */ +typedef struct xo_buffer_s { + char *xb_bufp; /* Buffer memory */ + char *xb_curp; /* Current insertion point */ + ssize_t xb_size; /* Size of buffer */ +} xo_buffer_t; + +/* + * Initialize the contents of an xo_buffer_t. + */ +static inline void +xo_buf_init (xo_buffer_t *xbp) +{ + xbp->xb_size = XO_BUFSIZ; + xbp->xb_bufp = xo_realloc(NULL, xbp->xb_size); + xbp->xb_curp = xbp->xb_bufp; +} + +/* + * Reset the buffer to empty + */ +static inline void +xo_buf_reset (xo_buffer_t *xbp) +{ + xbp->xb_curp = xbp->xb_bufp; +} + +/* + * Return the number of bytes left in the buffer + */ +static inline int +xo_buf_left (xo_buffer_t *xbp) +{ + return xbp->xb_size - (xbp->xb_curp - xbp->xb_bufp); +} + +/* + * See if the buffer to empty + */ +static inline int +xo_buf_is_empty (xo_buffer_t *xbp) +{ + return (xbp->xb_curp == xbp->xb_bufp); +} + +/* + * Return the current offset + */ +static inline ssize_t +xo_buf_offset (xo_buffer_t *xbp) +{ + return xbp ? (xbp->xb_curp - xbp->xb_bufp) : 0; +} + +static inline char * +xo_buf_data (xo_buffer_t *xbp, ssize_t offset) +{ + if (xbp == NULL) + return NULL; + return xbp->xb_bufp + offset; +} + +static inline char * +xo_buf_cur (xo_buffer_t *xbp) +{ + if (xbp == NULL) + return NULL; + return xbp->xb_curp; +} + +/* + * Initialize the contents of an xo_buffer_t. + */ +static inline void +xo_buf_cleanup (xo_buffer_t *xbp) +{ + if (xbp->xb_bufp) + xo_free(xbp->xb_bufp); + bzero(xbp, sizeof(*xbp)); +} + +/* + * Does the buffer have room for the given number of bytes of data? + * If not, realloc the buffer to make room. If that fails, we + * return 0 to tell the caller they are in trouble. + */ +static inline int +xo_buf_has_room (xo_buffer_t *xbp, ssize_t len) +{ + if (xbp->xb_curp + len >= xbp->xb_bufp + xbp->xb_size) { + /* + * Find out how much new space we need, round it up to XO_BUFSIZ + */ + ssize_t sz = (xbp->xb_curp + len) - xbp->xb_bufp; + sz = (sz + XO_BUFSIZ - 1) & ~(XO_BUFSIZ - 1); + + char *bp = xo_realloc(xbp->xb_bufp, sz); + if (bp == NULL) + return 0; + + xbp->xb_curp = bp + (xbp->xb_curp - xbp->xb_bufp); + xbp->xb_bufp = bp; + xbp->xb_size = sz; + } + + return 1; +} + +/* + * Append the given string to the given buffer + */ +static inline void +xo_buf_append (xo_buffer_t *xbp, const char *str, ssize_t len) +{ + if (str == NULL || len == 0 || !xo_buf_has_room(xbp, len)) + return; + + memcpy(xbp->xb_curp, str, len); + xbp->xb_curp += len; +} + +/* + * Append the given NUL-terminated string to the given buffer + */ +static inline void +xo_buf_append_str (xo_buffer_t *xbp, const char *str) +{ + ssize_t len = strlen(str); + + if (!xo_buf_has_room(xbp, len)) + return; + + memcpy(xbp->xb_curp, str, len); + xbp->xb_curp += len; +} + +#endif /* XO_BUF_H */ diff --git a/contrib/libxo/libxo/xo_create.3 b/contrib/libxo/libxo/xo_create.3 new file mode 100644 index 000000000000..ea811c27e5c1 --- /dev/null +++ b/contrib/libxo/libxo/xo_create.3 @@ -0,0 +1,77 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_create , xo_create_to_file , xo_destroy +.Nd create and destroy libxo output handles +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_handle_t * +.Fn xo_create "unsigned style" "unsigned flags" +.Ft xo_handle_t * +.Fn xo_create_to_file "FILE *fp" "unsigned style" "unsigned flags" +.Ft void +.Fn xo_destroy "xo_handle_t *handle" +.Sh DESCRIPTION +A +.Nm libxo +handle can be allocated using the +.Fn xo_create +function. +.Bd -literal -offset indent + Example: + xo_handle_t *xop = xo_create(XO_STYLE_JSON, XOF_WARN); + .... + xo_emit_h(xop, "testing\\n"); +.Ed +.Pp +By default, +.Nm libxo +writes output to standard output. +A convenience +function is provided for situations when output should be written to a +different file. +.Pp +Use the +.Dv XOF_CLOSE_FP +flag to trigger a call to +.Xr fclose 3 +for the +.Dv FILE +pointer when the handle is destroyed. +.Pp +The +.Fn xo_destroy +function releases a handle and any resources it is +using. +Calling +.Fn xo_destroy +with a +.Dv NULL +handle will release any +resources associated with the default handle. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr xo_set_options 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_emit.3 b/contrib/libxo/libxo/xo_emit.3 new file mode 100644 index 000000000000..cbf9d2b11eb4 --- /dev/null +++ b/contrib/libxo/libxo/xo_emit.3 @@ -0,0 +1,116 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_emit , xo_emit_h , xo_emit_hv +.Nd emit formatted output based on format string and arguments +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_emit "const char *fmt" "..." +.Ft xo_ssize_t +.Fn xo_emit_h "xo_handle_t *xop" "const char *fmt" "..." +.Ft xo_ssize_t +.Fn xo_emit_hv "xo_handle_t *xop" "const char *fmt" "va_list vap" +.Sh DESCRIPTION +The +.Fn xo_emit +function emits formatted output using the description in a format +string along with a set of zero or more arguments, in a style similar +to +.Xr printf 3 +but using a more complex format description string, as described in +.Xr xo_format 5 . +.Pp +.Fn xo_emit +uses the default output handle, as described in +.Xr libxo 3 , +where +.Fn xo_emit_h +uses an explicit handle. +.Fn xo_emit_hv +accepts a +.Fa va_list +for additional flexibility. +.Sh EXAMPLES +In this example, a set of four values is emitted using the following +source code: +.Bd -literal -offset indent + xo_emit(" {:lines/%7ju} {:words/%7ju} " + "{:characters/%7ju} {d:filename/%s}\\n", + linect, wordct, charct, file); +.Ed +Output can then be generated in various style, using +the "--libxo" option: +.Bd -literal -offset indent + % wc /etc/motd + 25 165 1140 /etc/motd + % wc --libxo xml,pretty,warn /etc/motd + <wc> + <file> + <lines>25</lines> + <words>165</words> + <characters>1140</characters> + <filename>/etc/motd</filename> + </file> + </wc> + % wc --libxo json,pretty,warn /etc/motd + { + "wc": { + "file": [ + { + "lines": 25, + "words": 165, + "characters": 1140, + "filename": "/etc/motd" + } + ] + } + } + % wc --libxo html,pretty,warn /etc/motd + <div class="line"> + <div class="text"> </div> + <div class="data" data-tag="lines"> 25</div> + <div class="text"> </div> + <div class="data" data-tag="words"> 165</div> + <div class="text"> </div> + <div class="data" data-tag="characters"> 1140</div> + <div class="text"> </div> + <div class="data" data-tag="filename">/etc/motd</div> + </div> +.Ed +.Sh RETURN CODE +.Nm +returns a negative value on error. If the +.Nm XOF_COLUMNS +flag has been turned on for the specific handle using +.Xr xo_set_flags 3 , +then the number of display columns consumed by the output will be returned. +.Sh SEE ALSO +.Xr xo_open_container 3 , +.Xr xo_open_list 3 , +.Xr xo_emit_f 3 , +.Xo xo_emit_field 3 , +.Xr xo_format 5 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_emit_err.3 b/contrib/libxo/libxo/xo_emit_err.3 new file mode 100644 index 000000000000..eae44b746c28 --- /dev/null +++ b/contrib/libxo/libxo/xo_emit_err.3 @@ -0,0 +1,82 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_emit_err , xo_emit_errc , xo_emit_errx +.Nm xo_emit_warn , xo_emit_warnx , xo_emit_warn_c , xo_emit_warn_hc +.Nd emit errors and warnings in multiple output styles +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_emit_warn "const char *fmt" "..." +.Ft void +.Fn xo_emit_warnx "const char *fmt" "..." +.Ft void +.Fn xo_emit_warn_c "int code" "const char *fmt" "..." +.Ft void +.Fn xo_emit_warn_hc "xo_handle_t *xop" "int code, const char *fmt" "..." +.Ft void +.Fn xo_emit_err "int eval" "const char *fmt" "..." +.Ft void +.Fn xo_emit_errc "int eval" "int code" "const char *fmt" "..." +.Ft void +.Fn xo_emit_errx "int eval" "const char *fmt" "..." +.Sh DESCRIPTION +Many programs make use of the standard library functions +.Xr err 3 +and +.Xr warn 3 +to generate errors and warnings for the user. +.Nm libxo +wants to +pass that information via the current output style, and provides +compatible functions to allow this. +.Pp +The +.Fa fmt +argument is one compatible with +.Xr xo_emit 3 +which allows these functions make structured data. +To generate unstructured data, +use the +.Xr xo_err 3 +functions. +.Pp +These functions display the program name, a colon, a formatted message +based on the arguments, and then optionally a colon and an error +message associated with either +.Fa errno +or the +.Fa code +parameter. +.Bd -literal -offset indent + EXAMPLE: + if (open(filename, O_RDONLY) < 0) + xo_err(1, "cannot open file '%s'", filename); +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr xo_format 5 , +.Xr xo_err 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_emit_f.3 b/contrib/libxo/libxo/xo_emit_f.3 new file mode 100644 index 000000000000..f8ac013256a8 --- /dev/null +++ b/contrib/libxo/libxo/xo_emit_f.3 @@ -0,0 +1,121 @@ +.\" # +.\" # Copyright (c) 2016, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, April 2016 +.\" +.Dd April 15, 2016 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_emit_f , xo_emit_hf , xo_emit_hvf +.Nd emit formatted output based on format string and arguments +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_emit_f "xo_emit_flags_t flags" "const char *fmt" "..." +.Ft xo_ssize_t +.Fn xo_emit_hf "xo_handle_t *xop" "xo_emit_flags_t flags" "const char *fmt" "..." +.Ft xo_ssize_t +.Fn xo_emit_hvf "xo_handle_t *xop" "xo_emit_flags_t flags" "const char *fmt" "va_list vap" +.Ft void +.Fn xo_retain_clear_all "void" +.Ft void +.Fn xo_retain_clear "const char *fmt" +.Sh DESCRIPTION +These functions allow callers to pass a set of flags to +.Nm +emitting functions. These processing of arguments, except for +.Fa flags , +is identical to the base functions. +See +.Xr xo_emit 3 +for additional information. +.Pp +The only currently defined flag is +.Dv XOEF_RETAIN . +.Nm +can retain the parsed internal information related to the given +format string, allowing subsequent +.Xr xo_emit 3 +calls, the retained +information is used, avoiding repetitive parsing of the format string. +To retain parsed format information, use the +.Dv XOEF_RETAIN +flag to the +.Fn xo_emit_f +function. +.Pp +The format string must be immutable across multiple calls to +.Xn xo_emit_f , +since the library retains the string. +Typically this is done by using +static constant strings, such as string literals. If the string is not +immutable, the +.Dv XOEF_RETAIN +flag must not be used. +.Pp +The functions +.Fn xo_retain_clear +and +.Fn xo_retain_clear_all +release internal information on either a single format string or all +format strings, respectively. +Neither is required, but the library will +retain this information until it is cleared or the process exits. +.Pp +The retained information is kept as thread-specific data. +.Pp +Use +.Fn xo_retain_clear +and +.Fn xo_retain_clear_all +to clear the retained information, clearing the retained information +for either a specific format string or all format strings, respectively. +These functions are only needed when the calling application wants to +clear this information; they are not generally needed. +.Sh EXAMPLES +.Pp +.Bd -literal -offset indent + for (i = 0; i < 1000; i++) { + xo_open_instance("item"); + xo_emit_f(XOEF_RETAIN, "{:name} {:count/%d}\\n", + name[i], count[i]); + } +.Ed +.Pp +In this example, the caller desires to clear the retained information. +.Bd -literal -offset indent + const char *fmt = "{:name} {:count/%d}\\n"; + for (i = 0; i < 1000; i++) { + xo_open_instance("item"); + xo_emit_f(XOEF_RETAIN, fmt, name[i], count[i]); + } + xo_retain_clear(fmt); +.Ed +.Sh RETURN CODE +The return values for these functions is identical to those of their +traditional counterparts. See +.Xr xo_emit 3 +for details. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr xo_open_container 3 , +.Xr xo_open_list 3 , +.Xr xo_format 5 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_emit_field.3 b/contrib/libxo/libxo/xo_emit_field.3 new file mode 100644 index 000000000000..4f9636cee8e7 --- /dev/null +++ b/contrib/libxo/libxo/xo_emit_field.3 @@ -0,0 +1,113 @@ +.\" # +.\" # Copyright (c) 2021, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_emit_field +.Nd emit formatted output based on format string and arguments +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_emit_field "const char *rolmod" "const char *content" "const char *fmt" "const char *efmt" "..." +.Ft xo_ssize_t +.Fn xo_emit_field_h "xo_handle_t *xop" "const char *rolmod" "const char *content" "const char *fmt" const char *efmt" "..." +.Ft xo_ssize_t +.Fn xo_emit_field_hv "xo_handle_t *xop" "const char *rolmod" "const char *content" "const char *fmt" "const char *efmt" "va_list vap" +.Sh DESCRIPTION +The +.Fn xo_emit_field +function emits formatted output similar to +.Xr xo_emit 3 +but where +.Fn xo_emit +uses a single string argument containing the description +for multiple fields, +.Fn xo_emit_field +emits a single field using multiple arguments to contain the +field description. +.Fn xo_emit_field_h +adds an explicit handle to use instead of the default +handle, while +.Fn xo_emit_field_hv +accepts a +.Fa va_list +for additional flexibility. +.Pp +The arguments +.Fa rolmod , +.Fa content , +.Fa fmt , +and +.Fa efmt +are detailed in +.Xr xo_format 5 . +Using distinct arguments allows callers to pass the field description +in pieces, rather than having to use something like +.Xr snprintf 3 +to build the format string required by +.Fn xo_emit . +The arguments are each NUL-terminated strings. The +.Fa rolmod +argument contains the "role" and "modifier" portions of +the field description, the +.Fa content +argument contains the "content" portion, and the +.Fa fmt +and +.Fa efmt +contain the "field-format" and "encoding-format" portions, respectively. +.Pp +As with xo_emit, the +.Fa fmt +and +.Fa efmt +values are both optional, since the field-format string +defaults to "%s", and the encoding-format's default value is +derived from the field-format +per +.Xr xo_format 5 . +However, care must be taken to avoid using a value directly as the +format, since characters like '{', '%', and '}' will be interpreted +as formatting directives, and may cause +.Nm +to dereference arbitrary values off the stack, leading to bugs, +core files, and gnashing of teeth. +.Sh EXAMPLES +In this example, a set of four values is emitted using the following +source code: +.Bd -literal -offset indent + xo_emit_field("T", title, NULL, NULL, NULL); + xo_emit_field("Vt", "max-chaos", NULL, NULL, " very "); + xo_emit_field("V", "min-chaos", "%02d", "%d", 42); + xo_emit_field_h(NULL, ",leaf-list,quotes", "sku", "%s-%u", "%s-000-%u", + "gum", 1412); +.Ed +.Sh RETURN CODE +.Nm +returns a negative value on error. If the +.Nm XOF_COLUMNS +flag has been turned on for the specific handle using +.Xr xo_set_flags 3 , +then the number of display columns consumed by the output will be returned. +.Sh SEE ALSO +.Xr xo_format 5 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . diff --git a/contrib/libxo/libxo/xo_encoder.c b/contrib/libxo/libxo/xo_encoder.c new file mode 100644 index 000000000000..5d195e06a2a8 --- /dev/null +++ b/contrib/libxo/libxo/xo_encoder.c @@ -0,0 +1,444 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, August 2015 + */ + +/** + * libxo includes a number of fixed encoding styles. But other + * external encoders are need to deal with new encoders. Rather + * than expose a swarm of libxo internals, we create a distinct + * API, with a simpler API than we use internally. + */ + +#include <stdio.h> +#include <unistd.h> +#include <string.h> +#include <sys/queue.h> +#include <sys/param.h> +#include <dlfcn.h> + +#include "xo_config.h" +#include "xo.h" +#include "xo_encoder.h" + +#ifdef HAVE_DLFCN_H +#include <dlfcn.h> +#if !defined(HAVE_DLFUNC) +#define dlfunc(_p, _n) dlsym(_p, _n) +#endif +#else /* HAVE_DLFCN_H */ +#define dlopen(_n, _f) NULL /* Fail */ +#define dlsym(_p, _n) NULL /* Fail */ +#define dlfunc(_p, _n) NULL /* Fail */ +#endif /* HAVE_DLFCN_H */ + +static void xo_encoder_setup (void); /* Forward decl */ + +/* + * Need a simple string collection + */ +typedef struct xo_string_node_s { + TAILQ_ENTRY(xo_string_node_s) xs_link; /* Next string */ + char xs_data[0]; /* String data */ +} xo_string_node_t; + +typedef TAILQ_HEAD(xo_string_list_s, xo_string_node_s) xo_string_list_t; + +static inline void +xo_string_list_init (xo_string_list_t *listp) +{ + if (listp->tqh_last == NULL) + TAILQ_INIT(listp); +} + +static inline xo_string_node_t * +xo_string_add (xo_string_list_t *listp, const char *str) +{ + if (listp == NULL || str == NULL) + return NULL; + + xo_string_list_init(listp); + size_t len = strlen(str); + xo_string_node_t *xsp; + + xsp = xo_realloc(NULL, sizeof(*xsp) + len + 1); + if (xsp) { + memcpy(xsp->xs_data, str, len); + xsp->xs_data[len] = '\0'; + TAILQ_INSERT_TAIL(listp, xsp, xs_link); + } + + return xsp; +} + +#define XO_STRING_LIST_FOREACH(_xsp, _listp) \ + xo_string_list_init(_listp); \ + TAILQ_FOREACH(_xsp, _listp, xs_link) + +static inline void +xo_string_list_clean (xo_string_list_t *listp) +{ + xo_string_node_t *xsp; + + xo_string_list_init(listp); + + for (;;) { + xsp = TAILQ_FIRST(listp); + if (xsp == NULL) + break; + TAILQ_REMOVE(listp, xsp, xs_link); + xo_free(xsp); + } +} + +static xo_string_list_t xo_encoder_path; + +void +xo_encoder_path_add (const char *path) +{ + xo_encoder_setup(); + + if (path) + xo_string_add(&xo_encoder_path, path); +} + +/* ---------------------------------------------------------------------- */ + +typedef struct xo_encoder_node_s { + TAILQ_ENTRY(xo_encoder_node_s) xe_link; /* Next session */ + char *xe_name; /* Name for this encoder */ + xo_encoder_func_t xe_handler; /* Callback function */ + void *xe_dlhandle; /* dlopen handle */ +} xo_encoder_node_t; + +typedef TAILQ_HEAD(xo_encoder_list_s, xo_encoder_node_s) xo_encoder_list_t; + +#define XO_ENCODER_LIST_FOREACH(_xep, _listp) \ + xo_encoder_list_init(_listp); \ + TAILQ_FOREACH(_xep, _listp, xe_link) + +static xo_encoder_list_t xo_encoders; + +static void +xo_encoder_list_init (xo_encoder_list_t *listp) +{ + if (listp->tqh_last == NULL) + TAILQ_INIT(listp); +} + +static xo_encoder_node_t * +xo_encoder_list_add (const char *name) +{ + if (name == NULL) + return NULL; + + xo_encoder_node_t *xep = xo_realloc(NULL, sizeof(*xep)); + if (xep) { + ssize_t len = strlen(name) + 1; + xep->xe_name = xo_realloc(NULL, len); + if (xep->xe_name == NULL) { + xo_free(xep); + return NULL; + } + + memcpy(xep->xe_name, name, len); + + TAILQ_INSERT_TAIL(&xo_encoders, xep, xe_link); + } + + return xep; +} + +void +xo_encoders_clean (void) +{ + xo_encoder_node_t *xep; + + xo_encoder_setup(); + + for (;;) { + xep = TAILQ_FIRST(&xo_encoders); + if (xep == NULL) + break; + + TAILQ_REMOVE(&xo_encoders, xep, xe_link); + + if (xep->xe_dlhandle) + dlclose(xep->xe_dlhandle); + + xo_free(xep); + } + + xo_string_list_clean(&xo_encoder_path); +} + +static void +xo_encoder_setup (void) +{ + static int initted; + if (!initted) { + initted = 1; + + xo_string_list_init(&xo_encoder_path); + xo_encoder_list_init(&xo_encoders); + + xo_encoder_path_add(XO_ENCODERDIR); + } +} + +static xo_encoder_node_t * +xo_encoder_find (const char *name) +{ + xo_encoder_node_t *xep; + + xo_encoder_list_init(&xo_encoders); + + XO_ENCODER_LIST_FOREACH(xep, &xo_encoders) { + if (xo_streq(xep->xe_name, name)) + return xep; + } + + return NULL; +} + +/* + * Return the encoder function for a specific shared library. This is + * really just a means of keeping the annoying gcc verbiage out of the + * main code. And that's only need because gcc breaks dlfunc's + * promise that I can cast it's return value to a function: "The + * precise return type of dlfunc() is unspecified; applications must + * cast it to an appropriate function pointer type." + */ +static xo_encoder_init_func_t +xo_encoder_func (void *dlp) +{ + xo_encoder_init_func_t func; + +#if defined(HAVE_GCC) && __GNUC__ > 8 +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wcast-function-type" +#endif /* HAVE_GCC */ + + func = (xo_encoder_init_func_t) dlfunc(dlp, XO_ENCODER_INIT_NAME); + +#if defined(HAVE_GCC) && __GNUC__ > 8 +#pragma GCC diagnostic pop /* Restore previous setting */ +#endif /* HAVE_GCC */ + + return func; +} + +static xo_encoder_node_t * +xo_encoder_discover (const char *name) +{ + void *dlp = NULL; + char buf[MAXPATHLEN]; + xo_string_node_t *xsp; + xo_encoder_node_t *xep = NULL; + + XO_STRING_LIST_FOREACH(xsp, &xo_encoder_path) { + static const char fmt[] = "%s/%s.enc"; + char *dir = xsp->xs_data; + size_t len = snprintf(buf, sizeof(buf), fmt, dir, name); + + if (len > sizeof(buf)) /* Should not occur */ + continue; + + dlp = dlopen((const char *) buf, RTLD_NOW); + if (dlp) + break; + } + + if (dlp) { + /* + * If the library exists, find the initializer function and + * call it. + */ + xo_encoder_init_func_t func; + + func = xo_encoder_func(dlp); + if (func) { + xo_encoder_init_args_t xei; + + bzero(&xei, sizeof(xei)); + + xei.xei_version = XO_ENCODER_VERSION; + ssize_t rc = func(&xei); + if (rc == 0 && xei.xei_handler) { + xep = xo_encoder_list_add(name); + if (xep) { + xep->xe_handler = xei.xei_handler; + xep->xe_dlhandle = dlp; + } + } + } + + if (xep == NULL) + dlclose(dlp); + } + + return xep; +} + +void +xo_encoder_register (const char *name, xo_encoder_func_t func) +{ + xo_encoder_setup(); + + xo_encoder_node_t *xep = xo_encoder_find(name); + + if (xep) /* "We alla-ready got one" */ + return; + + xep = xo_encoder_list_add(name); + if (xep) + xep->xe_handler = func; +} + +void +xo_encoder_unregister (const char *name) +{ + xo_encoder_setup(); + + xo_encoder_node_t *xep = xo_encoder_find(name); + if (xep) { + TAILQ_REMOVE(&xo_encoders, xep, xe_link); + xo_free(xep); + } +} + +int +xo_encoder_init (xo_handle_t *xop, const char *name) +{ + xo_encoder_setup(); + + char opts_char = '\0'; + const char *col_opts = strchr(name, ':'); + const char *plus_opts = strchr(name, '+'); + + /* + * Find the option-separating character (plus or colon) which + * appears first in the options string. + */ + const char *opts = (col_opts == NULL) ? plus_opts + : (plus_opts == NULL) ? col_opts + : (plus_opts < col_opts) ? plus_opts : col_opts; + + if (opts) { + opts_char = *opts; + + /* Make a writable copy of the name */ + size_t len = strlen(name); + char *copy = alloca(len + 1); + memcpy(copy, name, len); + copy[len] = '\0'; + + char *opts_copy = copy + (opts - name); /* Move to ':' */ + *opts_copy++ = '\0'; /* Trim it off */ + + opts = opts_copy; /* Use copy as options */ + name = copy; /* Use trimmed copy as name */ + } + + /* Can't have names containing '/' or ':' */ + if (strchr(name, '/') != NULL || strchr(name, ':') != NULL) { + xo_failure(xop, "invalid encoder name: %s", name); + return -1; + } + + /* + * First we look on the list of known (registered) encoders. + * If we don't find it, we follow the set of paths to find + * the encoding library. + */ + xo_encoder_node_t *xep = xo_encoder_find(name); + if (xep == NULL) { + xep = xo_encoder_discover(name); + if (xep == NULL) { + xo_failure(xop, "encoder not founde: %s", name); + return -1; + } + } + + xo_set_encoder(xop, xep->xe_handler); + + int rc = xo_encoder_handle(xop, XO_OP_CREATE, name, NULL, 0); + if (rc == 0 && opts != NULL) { + xo_encoder_op_t op; + + /* Encoder API is limited, so we're stuck with two different options */ + op = (opts_char == '+') ? XO_OP_OPTIONS_PLUS : XO_OP_OPTIONS; + rc = xo_encoder_handle(xop, op, name, opts, 0); + } + + return rc; +} + +/* + * A couple of function varieties here, to allow for multiple + * use cases. This variant is for when the main program knows + * its own encoder needs. + */ +xo_handle_t * +xo_encoder_create (const char *name, xo_xof_flags_t flags) +{ + xo_handle_t *xop; + + xop = xo_create(XO_STYLE_ENCODER, flags); + if (xop) { + if (xo_encoder_init(xop, name)) { + xo_destroy(xop); + xop = NULL; + } + } + + return xop; +} + +int +xo_encoder_handle (xo_handle_t *xop, xo_encoder_op_t op, + const char *name, const char *value, xo_xff_flags_t flags) +{ + void *private = xo_get_private(xop); + xo_encoder_func_t func = xo_get_encoder(xop); + + if (func == NULL) + return -1; + + return func(xop, op, name, value, private, flags); +} + +const char * +xo_encoder_op_name (xo_encoder_op_t op) +{ + static const char *names[] = { + /* 0 */ "unknown", + /* 1 */ "create", + /* 2 */ "open_container", + /* 3 */ "close_container", + /* 4 */ "open_list", + /* 5 */ "close_list", + /* 6 */ "open_leaf_list", + /* 7 */ "close_leaf_list", + /* 8 */ "open_instance", + /* 9 */ "close_instance", + /* 10 */ "string", + /* 11 */ "content", + /* 12 */ "finish", + /* 13 */ "flush", + /* 14 */ "destroy", + /* 15 */ "attr", + /* 16 */ "version", + /* 17 */ "options", + }; + + if (op > sizeof(names) / sizeof(names[0])) + return "unknown"; + + return names[op]; +} diff --git a/contrib/libxo/libxo/xo_encoder.h b/contrib/libxo/libxo/xo_encoder.h new file mode 100644 index 000000000000..bb57194ab030 --- /dev/null +++ b/contrib/libxo/libxo/xo_encoder.h @@ -0,0 +1,178 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, August 2015 + */ + +/* + * NOTE WELL: This file is needed to software that implements an + * external encoder for libxo that allows libxo data to be encoded in + * new and bizarre formats. General libxo code should _never_ + * include this header file. + */ + +#ifndef XO_ENCODER_H +#define XO_ENCODER_H + +#include <string.h> + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* + * Expose libxo's memory allocation functions + */ +extern xo_realloc_func_t xo_realloc; +extern xo_free_func_t xo_free; + +/* + * Simple string comparison function (without the temptation + * to forget the "== 0"). + */ +static inline int +xo_streq (const char *one, const char *two) +{ + return strcmp(one, two) == 0; +} + +/* Flags for formatting functions */ +typedef unsigned long xo_xff_flags_t; +#define XFF_COLON (1<<0) /* Append a ":" */ +#define XFF_COMMA (1<<1) /* Append a "," iff there's more output */ +#define XFF_WS (1<<2) /* Append a blank */ +#define XFF_ENCODE_ONLY (1<<3) /* Only emit for encoding styles (XML, JSON) */ + +#define XFF_QUOTE (1<<4) /* Force quotes */ +#define XFF_NOQUOTE (1<<5) /* Force no quotes */ +#define XFF_DISPLAY_ONLY (1<<6) /* Only emit for display styles (text, html) */ +#define XFF_KEY (1<<7) /* Field is a key (for XPath) */ + +#define XFF_XML (1<<8) /* Force XML encoding style (for XPath) */ +#define XFF_ATTR (1<<9) /* Escape value using attribute rules (XML) */ +#define XFF_BLANK_LINE (1<<10) /* Emit a blank line */ +#define XFF_NO_OUTPUT (1<<11) /* Do not make any output */ + +#define XFF_TRIM_WS (1<<12) /* Trim whitespace off encoded values */ +#define XFF_LEAF_LIST (1<<13) /* A leaf-list (list of values) */ +#define XFF_UNESCAPE (1<<14) /* Need to printf-style unescape the value */ +#define XFF_HUMANIZE (1<<15) /* Humanize the value (for display styles) */ + +#define XFF_HN_SPACE (1<<16) /* Humanize: put space before suffix */ +#define XFF_HN_DECIMAL (1<<17) /* Humanize: add one decimal place if <10 */ +#define XFF_HN_1000 (1<<18) /* Humanize: use 1000, not 1024 */ +#define XFF_GT_FIELD (1<<19) /* Call gettext() on a field */ + +#define XFF_GT_PLURAL (1<<20) /* Call dngettext to find plural form */ +#define XFF_ARGUMENT (1<<21) /* Content provided via argument */ + +/* Flags to turn off when we don't want i18n processing */ +#define XFF_GT_FLAGS (XFF_GT_FIELD | XFF_GT_PLURAL) + +typedef unsigned xo_encoder_op_t; + +/* Encoder operations; names are in xo_encoder.c:xo_encoder_op_name() */ +#define XO_OP_UNKNOWN 0 +#define XO_OP_CREATE 1 /* Called when the handle is init'd */ +#define XO_OP_OPEN_CONTAINER 2 +#define XO_OP_CLOSE_CONTAINER 3 +#define XO_OP_OPEN_LIST 4 +#define XO_OP_CLOSE_LIST 5 +#define XO_OP_OPEN_LEAF_LIST 6 +#define XO_OP_CLOSE_LEAF_LIST 7 +#define XO_OP_OPEN_INSTANCE 8 +#define XO_OP_CLOSE_INSTANCE 9 +#define XO_OP_STRING 10 /* Quoted UTF-8 string */ +#define XO_OP_CONTENT 11 /* Other content */ +#define XO_OP_FINISH 12 /* Finish any pending output */ +#define XO_OP_FLUSH 13 /* Flush any buffered output */ +#define XO_OP_DESTROY 14 /* Clean up function */ +#define XO_OP_ATTRIBUTE 15 /* Attribute name/value */ +#define XO_OP_VERSION 16 /* Version string */ +#define XO_OP_OPTIONS 17 /* Additional command line options */ +#define XO_OP_OPTIONS_PLUS 18 /* Additional command line options */ + +#define XO_ENCODER_HANDLER_ARGS \ + xo_handle_t *xop __attribute__ ((__unused__)), \ + xo_encoder_op_t op __attribute__ ((__unused__)), \ + const char *name __attribute__ ((__unused__)), \ + const char *value __attribute__ ((__unused__)), \ + void *private __attribute__ ((__unused__)), \ + xo_xff_flags_t flags __attribute__ ((__unused__)) + +typedef int (*xo_encoder_func_t)(XO_ENCODER_HANDLER_ARGS); + +typedef struct xo_encoder_init_args_s { + unsigned xei_version; /* Current version */ + xo_encoder_func_t xei_handler; /* Encoding handler */ +} xo_encoder_init_args_t; + +#define XO_ENCODER_VERSION 1 /* Current version */ + +#define XO_ENCODER_INIT_ARGS \ + xo_encoder_init_args_t *arg __attribute__ ((__unused__)) + +typedef int (*xo_encoder_init_func_t)(XO_ENCODER_INIT_ARGS); +/* + * Each encoder library must define a function named xo_encoder_init + * that takes the arguments defined in XO_ENCODER_INIT_ARGS. It + * should return zero for success. + */ +#define XO_ENCODER_INIT_NAME_TOKEN xo_encoder_library_init +#define XO_STRINGIFY(_x) #_x +#define XO_STRINGIFY2(_x) XO_STRINGIFY(_x) +#define XO_ENCODER_INIT_NAME XO_STRINGIFY2(XO_ENCODER_INIT_NAME_TOKEN) +extern int XO_ENCODER_INIT_NAME_TOKEN (XO_ENCODER_INIT_ARGS); + +void +xo_encoder_register (const char *name, xo_encoder_func_t func); + +void +xo_encoder_unregister (const char *name); + +void * +xo_get_private (xo_handle_t *xop); + +void +xo_encoder_path_add (const char *path); + +void +xo_set_private (xo_handle_t *xop, void *opaque); + +xo_encoder_func_t +xo_get_encoder (xo_handle_t *xop); + +void +xo_set_encoder (xo_handle_t *xop, xo_encoder_func_t encoder); + +int +xo_encoder_init (xo_handle_t *xop, const char *name); + +xo_handle_t * +xo_encoder_create (const char *name, xo_xof_flags_t flags); + +int +xo_encoder_handle (xo_handle_t *xop, xo_encoder_op_t op, + const char *name, const char *value, xo_xff_flags_t flags); + +void +xo_encoders_clean (void); + +const char * +xo_encoder_op_name (xo_encoder_op_t op); + +/* + * xo_failure is used to announce internal failures, when "warn" is on + */ +void +xo_failure (xo_handle_t *xop, const char *fmt, ...); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* XO_ENCODER_H */ diff --git a/contrib/libxo/libxo/xo_err.3 b/contrib/libxo/libxo/xo_err.3 new file mode 100644 index 000000000000..87cf2010a8a1 --- /dev/null +++ b/contrib/libxo/libxo/xo_err.3 @@ -0,0 +1,84 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_err , xo_errc , xo_errx +.Nm xo_warn , xo_warnx , xo_warn_c , xo_warn_hc +.Nd emit errors and warnings in multiple output styles +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_warn "const char *fmt" "..." +.Ft void +.Fn xo_warnx "const char *fmt" "..." +.Ft void +.Fn xo_warn_c "int code" "const char *fmt" "..." +.Ft void +.Fn xo_warn_hc "xo_handle_t *xop" "int code, const char *fmt" "..." +.Ft void +.Fn xo_err "int eval" "const char *fmt" "..." +.Ft void +.Fn xo_errc "int eval" "int code" "const char *fmt" "..." +.Ft void +.Fn xo_errx "int eval" "const char *fmt" "..." +.Sh DESCRIPTION +Many programs make use of the standard library functions +.Xr err 3 +and +.Xr warn 3 +to generate errors and warnings for the user. +.Nm libxo +wants to +pass that information via the current output style, and provides +compatible functions to allow this. +.Pp +The +.Fa fmt +argument is one compatible with +.Xr printf 3 +rather than +.Xr xo_emit 3 +to aid in simple conversion. This means +these functions make unstructured data. +To generate structured data, +use the +.Xr xo_emit_err 3 +functions. +.Pp +These functions display the program name, a colon, a formatted message +based on the arguments, and then optionally a colon and an error +message associated with either +.Fa errno +or the +.Fa code +parameter. +.Bd -literal -offset indent + EXAMPLE: + if (open(filename, O_RDONLY) < 0) + xo_err(1, "cannot open file '%s'", filename); +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr xo_emit_err 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_error.3 b/contrib/libxo/libxo/xo_error.3 new file mode 100644 index 000000000000..0330af4142da --- /dev/null +++ b/contrib/libxo/libxo/xo_error.3 @@ -0,0 +1,51 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_error +.Nd generate simple error messages in multiple output styles +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_error "const char *fmt" "..." +.Sh DESCRIPTION +Use the +.Fn xo_error +function to generate error messages to standard error. +The +.Fa fmt +argument is a string containing printf-style formatting +instructions that describe the remaining arguments. +.Pp +When converting an application to +.Nm libxo , +one can replace +.Em "fprintf(stderr,...)" +calls with +.Fn xo_error +calls. +.Sh SEE ALSO +.Xr printf 3 , +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_explicit.h b/contrib/libxo/libxo/xo_explicit.h new file mode 100644 index 000000000000..2611cf13ce72 --- /dev/null +++ b/contrib/libxo/libxo/xo_explicit.h @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2019, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * + * Phil Shafer, March 2019 + */ + +#ifndef XO_EXPLICIT_H +#define XO_EXPLICIT_H + +/* + * NOTE WELL: This file is needed to software that implements an + * explicit transition between libxo states on its internal stack. + * General libxo code should _never_ include this header file. + */ + + +/* + * A word about states: We use a finite state machine (FMS) approach + * to help remove fragility from the caller's code. Instead of + * requiring a specific order of calls, we'll allow the caller more + * flexibility and make the library responsible for recovering from + * missed steps. The goal is that the library should not be capable + * of emitting invalid xml or json, but the developer shouldn't need + * to know or understand all the details about these encodings. + * + * You can think of states as either states or events, since they + * function rather like both. None of the XO_CLOSE_* events will + * persist as states, since the matching stack frame will be popped. + * Same is true of XSS_EMIT, which is an event that asks us to + * prep for emitting output fields. + */ + +/* Stack frame states */ +typedef unsigned xo_state_t; /* XSS_* values */ +#define XSS_INIT 0 /* Initial stack state */ +#define XSS_OPEN_CONTAINER 1 +#define XSS_CLOSE_CONTAINER 2 +#define XSS_OPEN_LIST 3 +#define XSS_CLOSE_LIST 4 +#define XSS_OPEN_INSTANCE 5 +#define XSS_CLOSE_INSTANCE 6 +#define XSS_OPEN_LEAF_LIST 7 +#define XSS_CLOSE_LEAF_LIST 8 +#define XSS_DISCARDING 9 /* Discarding data until recovered */ +#define XSS_MARKER 10 /* xo_open_marker's marker */ +#define XSS_EMIT 11 /* xo_emit has a leaf field */ +#define XSS_EMIT_LEAF_LIST 12 /* xo_emit has a leaf-list ({l:}) */ +#define XSS_FINISH 13 /* xo_finish was called */ + +#define XSS_MAX 13 + +void +xo_explicit_transition (xo_handle_t *xop, xo_state_t new_state, + const char *tag, xo_xof_flags_t flags); + +#endif /* XO_EXPLICIT_H */ diff --git a/contrib/libxo/libxo/xo_finish.3 b/contrib/libxo/libxo/xo_finish.3 new file mode 100644 index 000000000000..a61d5276b504 --- /dev/null +++ b/contrib/libxo/libxo/xo_finish.3 @@ -0,0 +1,49 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_finish , xo_finish_h +.Nd finish formatting output +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_finish "void" +.Ft xo_ssize_t +.Fn xo_finish_h "xo_handle_t *xop" +.Sh DESCRIPTION +When the program is ready to exit or close a handle, a call to +.Fn xo_finish +is required. +This flushes any buffered data, closes +open +.Nm libxo +constructs, and completes any pending operations. +.Pp +Calling this function is +.Em vital +to the proper operation of libxo, +especially for the non-TEXT output styles. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_flush.3 b/contrib/libxo/libxo/xo_flush.3 new file mode 100644 index 000000000000..d1375223f5e9 --- /dev/null +++ b/contrib/libxo/libxo/xo_flush.3 @@ -0,0 +1,45 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_flush , xo_flush_h +.Nd flush formatted output from libxo handle +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_flush "void" +.Ft xo_ssize_t +.Fn xo_flush_h "xo_handle_t *handle" +.Sh DESCRIPTION +.Nm libxo +buffers data, both for performance and consistency, but also to +allow some advanced features to work properly. +At various times, the +caller may wish to flush any data buffered within the library. +The +.Fn xo_flush +function is used for this. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_format.5 b/contrib/libxo/libxo/xo_format.5 new file mode 100644 index 000000000000..3c7ddc9dd1aa --- /dev/null +++ b/contrib/libxo/libxo/xo_format.5 @@ -0,0 +1,984 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_format +.Nd content of format descriptors for xo_emit +.Sh DESCRIPTION +.Pp +.Nm libxo +uses format strings to control the rendering of data into +various output styles, including +.Em text , +.Em XML , +.Em JSON , +and +.Em HTML . +Each format string contains a set of zero or more +.Dq "field descriptions" , +which describe independent data fields. +Each field description contains a set of +.Dq modifiers , +a +.Dq "content string" , +and zero, one, or two +.Dq "format descriptors" . +The modifiers tell +.Nm libxo +what the field is and how to treat it, while the format descriptors are +formatting instructions using +.Xr printf 3 Ns -style +format strings, telling +.Nm libxo +how to format the field. +The field description is placed inside +a set of braces, with a colon +.Ql ( \&: ) +after the modifiers and a slash +.Ql ( \&/ ) +before each format descriptors. +Text may be intermixed with +field descriptions within the format string. +.Pp +The field description is given as follows: +.Bd -literal -offset indent + \(aq{\(aq [ role | modifier ]* [\(aq,\(aq long\-names ]* \(aq:\(aq [ content ] + [ \(aq/\(aq field\-format [ \(aq/\(aq encoding\-format ]] \(aq}\(aq +.Ed +.Pp +The role describes the function of the field, while the modifiers +enable optional behaviors. +The contents, field\-format, and +encoding\-format are used in varying ways, based on the role. +These are described in the following sections. +.Pp +Braces can be escaped by using double braces, similar to "%%" in +.Xr printf 3 . +The format string "{{braces}}" would emit "{braces}". +.Pp +In the following example, three field descriptors appear. +The first +is a padding field containing three spaces of padding, the second is a +label ("In stock"), and the third is a value field ("in\-stock"). +The in\-stock field has a "%u" format that will parse the next argument +passed to the +.Xr xo_emit 3 , +function as an unsigned integer. +.Bd -literal -offset indent + xo_emit("{P: }{Lwc:In stock}{:in\-stock/%u}\\n", 65); +.Ed +.Pp +This single line of code can generate text ("In stock: 65\\n"), XML +("<in\-stock>65</in\-stock>"), JSON (\(aq"in\-stock": 65\(aq), or HTML (too +lengthy to be listed here). +.Pp +While roles and modifiers typically use single character for brevity, +there are alternative names for each which allow more verbose +formatting strings. +These names must be preceded by a comma, and may follow any +single\-character values: +.Bd -literal -offset indent + xo_emit("{L,white,colon:In stock}{,key:in\-stock/%u}\\n", 65); +.Ed +.Ss "Field Roles" +Field roles are optional, and indicate the role and formatting of the +content. +The roles are listed below; only one role is permitted: +.Bl -column "M" "Name12341234" +.It Sy "M" "Name " "Description" +.It C "color " "Field is a color or effect" +.It D "decoration " "Field is non\-text (e.g. colon, comma)" +.It E "error " "Field is an error message" +.It L "label " "Field is text that prefixes a value" +.It N "note " "Field is text that follows a value" +.It P "padding " "Field is spaces needed for vertical alignment" +.It T "title " "Field is a title value for headings" +.It U "units " "Field is the units for the previous value field" +.It V "value " "Field is the name of field (the default)" +.It W "warning " "Field is a warning message" +.It \&[ "start\-anchor" "Begin a section of anchored variable\-width text" +.It \&] "stop\-anchor " "End a section of anchored variable\-width text" +.El +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{L:Free}{D::}{P: }{:free/%u} {U:Blocks}\\n", + free_blocks); +.Ed +.Pp +When a role is not provided, the "value" role is used as the default. +.Pp +Roles and modifiers can also use more verbose names, when preceded by +a comma: +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{,label:Free}{,decoration::}{,padding: }" + "{,value:free/%u} {,units:Blocks}\\n", + free_blocks); +.Ed +.Ss "The Color Role ({C:})" +Colors and effects control how text values are displayed; they are +used for display styles (TEXT and HTML). +.Bd -literal -offset indent + xo_emit("{C:bold}{:value}{C:no\-bold}\\n", value); +.Ed +.Pp +Colors and effects remain in effect until modified by other "C"\-role +fields. +.Bd -literal -offset indent + xo_emit("{C:bold}{C:inverse}both{C:no\-bold}only inverse\\n"); +.Ed +.Pp +If the content is empty, the "reset" action is performed. +.Bd -literal -offset indent + xo_emit("{C:both,underline}{:value}{C:}\\n", value); +.Ed +.Pp +The content should be a comma\-separated list of zero or more colors or +display effects. +.Bd -literal -offset indent + xo_emit("{C:bold,underline,inverse}All three{C:no\-bold,no\-inverse}\\n"); +.Ed +.Pp +The color content can be either static, when placed directly within +the field descriptor, or a printf\-style format descriptor can be used, +if preceded by a slash ("/"): +.Bd -literal -offset indent + xo_emit("{C:/%s%s}{:value}{C:}", need_bold ? "bold" : "", + need_underline ? "underline" : "", value); +.Ed +.Pp +Color names are prefixed with either "fg\-" or "bg\-" to change the +foreground and background colors, respectively. +.Bd -literal -offset indent + xo_emit("{C:/fg\-%s,bg\-%s}{Lwc:Cost}{:cost/%u}{C:reset}\\n", + fg_color, bg_color, cost); +.Ed +.Pp +The following table lists the supported effects: +.Bl -column "no\-underline" +.It Sy "Name " "Description" +.It "bg\-xxxxx " "Change background color" +.It "bold " "Start bold text effect" +.It "fg\-xxxxx " "Change foreground color" +.It "inverse " "Start inverse (aka reverse) text effect" +.It "no\-bold " "Stop bold text effect" +.It "no\-inverse " "Stop inverse (aka reverse) text effect" +.It "no\-underline " "Stop underline text effect" +.It "normal " "Reset effects (only)" +.It "reset " "Reset colors and effects (restore defaults)" +.It "underline " "Start underline text effect" +.El +.Pp +The following color names are supported: +.Bl -column "no\-underline" +.It Sy "Name" +.It black +.It blue +.It cyan +.It default +.It green +.It magenta +.It red +.It white +.It yellow +.El +.Ss "The Decoration Role ({D:})" +Decorations are typically punctuation marks such as colons, +semi\-colons, and commas used to decorate the text and make it simpler +for human readers. +By marking these distinctly, HTML usage scenarios +can use CSS to direct their display parameters. +.Bd -literal -offset indent + xo_emit("{D:((}{:name}{D:))}\\n", name); +.Ed +.Ss "The Gettext Role ({G:})" +.Nm libxo +supports internationalization (i18n) through its use of +.Xr gettext 3 . +Use the "{G:}" role to request that the remaining part of +the format string, following the "{G:}" field, be handled using +.Fn gettext . +Since +.Fn gettext +uses the string as the key into the message catalog, +.Nm libxo +uses a simplified version of the format string that removes +unimportant field formatting and modifiers, stopping minor formatting +changes from impacting the expensive translation process. +A developer +change such as changing "/%06d" to "/%08d" should not force hand +inspection of all .po files. +.Pp +The simplified version can be generated for a single message using the +"xopo \-s <text>" command, or an entire .pot can be translated using +the "xopo \-f <input> \-o <output>" command. +.Bd -literal -offset indent + xo_emit("{G:}Invalid token\\n"); +.Ed +.Pp +The {G:} role allows a domain name to be set. +.Fn gettext +calls will +continue to use that domain name until the current format string +processing is complete, enabling a library function to emit strings +using it\(aqs own catalog. +The domain name can be either static as the +content of the field, or a format can be used to get the domain name +from the arguments. +.Bd -literal -offset indent + xo_emit("{G:libc}Service unavailable in restricted mode\\n"); +.Ed +.Ss "The Label Role ({L:})" +Labels are text that appears before a value. +.Bd -literal -offset indent + xo_emit("{Lwc:Cost}{:cost/%u}\\n", cost); +.Ed +.Pp +If a label needs to include a slash, it must be escaped using two +backslashes, one for the C compiler and one for +.Nm libxo . +.Bd -literal -offset indent + xo_emit("{Lc:Low\\\\/warn level}{:level/%s}\\n", level); +.Ed +.Ss "The Note Role ({N:})" +Notes are text that appears after a value. +.Bd -literal -offset indent + xo_emit("{:cost/%u} {N:per year}\\n", cost); +.Ed +.Ss "The Padding Role ({P:})" +Padding represents whitespace used before and between fields. +The padding content can be either static, when placed directly within +the field descriptor, or a printf\-style format descriptor can be used, +if preceded by a slash ("/"): +.Bd -literal -offset indent + xo_emit("{P: }{Lwc:Cost}{:cost/%u}\\n", cost); + xo_emit("{P:/30s}{Lwc:Cost}{:cost/%u}\\n", "", cost); +.Ed +.Ss "The Title Role ({T:})" +Titles are heading or column headers that are meant to be displayed to +the user. +The title can be either static, when placed directly within +the field descriptor, or a printf\-style format descriptor can be used, +if preceded by a slash ("/"): +.Bd -literal -offset indent + xo_emit("{T:Interface Statistics}\\n"); + xo_emit("{T:/%20.20s}{T:/%6.6s}\\n", "Item Name", "Cost"); +.Ed +.Ss "The Units Role ({U:})" +Units are the dimension by which values are measured, such as degrees, +miles, bytes, and decibels. +The units field carries this information +for the previous value field. +.Bd -literal -offset indent + xo_emit("{Lwc:Distance}{:distance/%u}{Uw:miles}\\n", miles); +.Ed +.Pp +Note that the sense of the \(aqw\(aq modifier is reversed for units; +a blank is added before the contents, rather than after it. +.Pp +When the +.Dv XOF_UNITS +flag is set, units are rendered in XML as the +.Dq units +attribute: +.Bd -literal -offset indent + <distance units="miles">50</distance> +.Ed +.Pp +Units can also be rendered in HTML as the "data\-units" attribute: +.Bd -literal -offset indent + <div class="data" data\-tag="distance" data\-units="miles" + data\-xpath="/top/data/distance">50</div> +.Ed +.Ss "The Value Role ({V:} and {:})" +The value role is used to represent the a data value that is +interesting for the non\-display output styles (XML and JSON). +Value +is the default role; if no other role designation is given, the field +is a value. +The field name must appear within the field descriptor, +followed by one or two format descriptors. +The first format +descriptor is used for display styles (TEXT and HTML), while the +second one is used for encoding styles (XML and JSON). +If no second +format is given, the encoding format defaults to the first format, +with any minimum width removed. +If no first format is given, both +format descriptors default to "%s". +.Bd -literal -offset indent + xo_emit("{:length/%02u}x{:width/%02u}x{:height/%02u}\\n", + length, width, height); + xo_emit("{:author} wrote \"{:poem}\" in {:year/%4d}\\n, + author, poem, year); +.Ed +.Ss "The Anchor Roles ({[:} and {]:})" +The anchor roles allow a set of strings by be padded as a group, +but still be visible to +.Xr xo_emit 3 +as distinct fields. +Either the start +or stop anchor can give a field width and it can be either directly in +the descriptor or passed as an argument. +Any fields between the start +and stop anchor are padded to meet the minimum width given. +.Pp +To give a width directly, encode it as the content of the anchor tag: +.Bd -literal -offset indent + xo_emit("({[:10}{:min/%d}/{:max/%d}{]:})\\n", min, max); +.Ed +.Pp +To pass a width as an argument, use "%d" as the format, which must +appear after the "/". +Note that only "%d" is supported for widths. +Using any other value could ruin your day. +.Bd -literal -offset indent + xo_emit("({[:/%d}{:min/%d}/{:max/%d}{]:})\\n", width, min, max); +.Ed +.Pp +If the width is negative, padding will be added on the right, suitable +for left justification. +Otherwise the padding will be added to the +left of the fields between the start and stop anchors, suitable for +right justification. +If the width is zero, nothing happens. +If the +number of columns of output between the start and stop anchors is less +than the absolute value of the given width, nothing happens. +.Pp +Widths over 8k are considered probable errors and not supported. +If +.Dv XOF_WARN +is set, a warning will be generated. +.Ss "Field Modifiers" +Field modifiers are flags which modify the way content emitted for +particular output styles: +.Bl -column M "Name123456789" +.It Sy M "Name " "Description" +.It a "argument " "The content appears as a ""const char *"" argument" +.It c "colon " "A colon ("":"") is appended after the label" +.It d "display " "Only emit field for display styles (text/HTML)" +.It e "encoding " "Only emit for encoding styles (XML/JSON)" +.It h "humanize (hn) " "Format large numbers in human\-readable style" +.It " " "hn\-space " "Humanize: Place space between numeric and unit" +.It " " "hn\-decimal " "Humanize: Add a decimal digit, if number < 10" +.It " " "hn\-1000 " "Humanize: Use 1000 as divisor instead of 1024" +.It k "key " "Field is a key, suitable for XPath predicates" +.It l "leaf\-list " "Field is a leaf\-list, a list of leaf values" +.It n "no\-quotes " "Do not quote the field when using JSON style" +.It q "quotes " "Quote the field when using JSON style" +.It t "trim " "Trim leading and trailing whitespace" +.It w "white space " "A blank ("" "") is appended after the label" +.El +.Pp +For example, the modifier string "Lwc" means the field has a label +role (text that describes the next field) and should be followed by a +colon (\(aqc\(aq) and a space (\(aqw\(aq). +The modifier string "Vkq" means the +field has a value role, that it is a key for the current instance, and +that the value should be quoted when encoded for JSON. +.Pp +Roles and modifiers can also use more verbose names, when preceded by +a comma. +For example, the modifier string "Lwc" (or "L,white,colon") +means the field has a label role (text that describes the next field) +and should be followed by a colon (\(aqc\(aq) and a space (\(aqw\(aq). +The modifier string "Vkq" (or ":key,quote") means the field has a value +role (the default role), that it is a key for the current instance, +and that the value should be quoted when encoded for JSON. +.Ss "The Argument Modifier ({a:})" +The argument modifier indicates that the content of the field +descriptor will be placed as a UTF\-8 string (const char *) argument +within the xo_emit parameters. +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{La:} {a:}\\n", "Label text", "label", "value"); + TEXT: + Label text value + JSON: + "label": "value" + XML: + <label>value</label> +.Ed +.Pp +The argument modifier allows field names for value fields to be passed +on the stack, avoiding the need to build a field descriptor using +.Xr snprintf 1 . +For many field roles, the argument modifier is not needed, +since those roles have specific mechanisms for arguments, +such as "{C:fg\-%s}". +.Ss "The Colon Modifier ({c:})" +The colon modifier appends a single colon to the data value: +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{Lc:Name}{:name}\\n", "phil"); + TEXT: + Name:phil +.Ed +.Pp +The colon modifier is only used for the TEXT and HTML output +styles. +It is commonly combined with the space modifier (\(aq{w:}\(aq). +It is purely a convenience feature. +.Ss "The Display Modifier ({d:})" +The display modifier indicated the field should only be generated for +the display output styles, TEXT and HTML. +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{Lcw:Name}{d:name} {:id/%d}\\n", "phil", 1); + TEXT: + Name: phil 1 + XML: + <id>1</id> +.Ed +.Pp +The display modifier is the opposite of the encoding modifier, and +they are often used to give to distinct views of the underlying data. +.Ss "The Encoding Modifier ({e:})" +The encoding modifier indicated the field should only be generated for +the encoding output styles, such as JSON and XML. +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{Lcw:Name}{:name} {e:id/%d}\\n", "phil", 1); + TEXT: + Name: phil + XML: + <name>phil</name><id>1</id> +.Ed +.Pp +The encoding modifier is the opposite of the display modifier, and +they are often used to give to distinct views of the underlying data. +.Ss "The Humanize Modifier ({h:})" +The humanize modifier is used to render large numbers as in a +human\-readable format. +While numbers like "44470272" are completely readable to computers and +savants, humans will generally find "44M" more meaningful. +.Pp +"hn" can be used as an alias for "humanize". +.Pp +The humanize modifier only affects display styles (TEXT and HMTL). +The "no\-humanize" option will block the function of the humanize modifier. +.Pp +There are a number of modifiers that affect details of humanization. +These are only available in as full names, not single characters. +The "hn\-space" modifier places a space between the number and any +multiplier symbol, such as "M" or "K" (ex: "44 K"). +The "hn\-decimal" modifier will add a decimal point and a single tenths digit +when the number is less than 10 (ex: "4.4K"). +The "hn\-1000" modifier will use 1000 as divisor instead of 1024, following the +JEDEC\-standard instead of the more natural binary powers\-of\-two +tradition. +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{h:input/%u}, {h,hn\-space:output/%u}, " + "{h,hn\-decimal:errors/%u}, {h,hn\-1000:capacity/%u}, " + "{h,hn\-decimal:remaining/%u}\\n", + input, output, errors, capacity, remaining); + TEXT: + 21, 57 K, 96M, 44M, 1.2G +.Ed +.Pp +In the HTML style, the original numeric value is rendered in the +"data\-number" attribute on the <div> element: +.Bd -literal -offset indent + <div class="data" data\-tag="errors" + data\-number="100663296">96M</div> +.Ed +.Ss "The Gettext Modifier ({g:})" +The gettext modifier is used to translate individual fields using the +gettext domain (typically set using the "{G:}" role) and current +language settings. +Once libxo renders the field value, it is passed +to +.Xr gettext 3 , +where it is used as a key to find the native language +translation. +.Pp +In the following example, the strings "State" and "full" are passed +to +.Fn gettext +to find locale\-based translated strings. +.Bd -literal -offset indent + xo_emit("{Lgwc:State}{g:state}\\n", "full"); +.Ed +.Ss "The Key Modifier ({k:})" +The key modifier is used to indicate that a particular field helps +uniquely identify an instance of list data. +.Bd -literal -offset indent + EXAMPLE: + xo_open_list("user"); + for (i = 0; i < num_users; i++) { + xo_open_instance("user"); + xo_emit("User {k:name} has {:count} tickets\\n", + user[i].u_name, user[i].u_tickets); + xo_close_instance("user"); + } + xo_close_list("user"); +.Ed +.Pp +Currently the key modifier is only used when generating XPath values +for the HTML output style when +.Dv XOF_XPATH +is set, but other uses are likely in the near future. +.Ss "The Leaf\-List Modifier ({l:})" +The leaf\-list modifier is used to distinguish lists where each +instance consists of only a single value. In XML, these are +rendered as single elements, where JSON renders them as arrays. +.Bd -literal -offset indent + EXAMPLE: + xo_open_list("user"); + for (i = 0; i < num_users; i++) { + xo_emit("Member {l:name}\\n", user[i].u_name); + } + xo_close_list("user"); + XML: + <user>phil</user> + <user>pallavi</user> + JSON: + "user": [ "phil", "pallavi" ] +.Ed +.Ss "The No\-Quotes Modifier ({n:})" +The no\-quotes modifier (and its twin, the \(aqquotes\(aq modifier) affect +the quoting of values in the JSON output style. +JSON uses quotes for +string values, but no quotes for numeric, boolean, and null data. +.Xr xo_emit 3 +applies a simple heuristic to determine whether quotes are +needed, but often this needs to be controlled by the caller. +.Bd -literal -offset indent + EXAMPLE: + const char *bool = is_true ? "true" : "false"; + xo_emit("{n:fancy/%s}", bool); + JSON: + "fancy": true +.Ed +.Ss "The Plural Modifier ({p:})" +The plural modifier selects the appropriate plural form of an +expression based on the most recent number emitted and the current +language settings. +The contents of the field should be the singular +and plural English values, separated by a comma: +.Bd -literal -offset indent + xo_emit("{:bytes} {Ngp:byte,bytes}\\n", bytes); +.Ed +.Pp +The plural modifier is meant to work with the gettext modifier ({g:}) +but can work independently. +.Pp +When used without the gettext modifier or when the message does not +appear in the message catalog, the first token is chosen when the last +numeric value is equal to 1; otherwise the second value is used, +mimicking the simple pluralization rules of English. +.Pp +When used with the gettext modifier, the +.Xr ngettext 3 +function is +called to handle the heavy lifting, using the message catalog to +convert the singular and plural forms into the native language. +.Ss "The Quotes Modifier ({q:})" +The quotes modifier (and its twin, the \(aqno-quotes\(aq modifier) affect +the quoting of values in the JSON output style. +JSON uses quotes for +string values, but no quotes for numeric, boolean, and null data. +.Xr xo_emit 3 +applies a simple heuristic to determine whether quotes are +needed, but often this needs to be controlled by the caller. +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{q:time/%d}", 2014); + JSON: + "year": "2014" +.Ed +.Ss "The White Space Modifier ({w:})" +The white space modifier appends a single space to the data value: +.Bd -literal -offset indent + EXAMPLE: + xo_emit("{Lw:Name}{:name}\\n", "phil"); + TEXT: + Name phil +.Ed +.Pp +The white space modifier is only used for the TEXT and HTML output +styles. +It is commonly combined with the colon modifier (\(aq{c:}\(aq). +It is purely a convenience feature. +.Pp +Note that the sense of the \(aqw\(aq modifier is reversed for the units role +({Uw:}); a blank is added before the contents, rather than after it. +.Ss "Field Formatting" +The field format is similar to the format string for +.Xr printf 3 . +Its use varies based on the role of the field, but generally is used to +format the field\(aqs contents. +.Pp +If the format string is not provided for a value field, it defaults +to "%s". +.Pp +Note a field definition can contain zero or more printf\-style +.Dq directives , +which are sequences that start with a \(aq%\(aq and end with +one of following characters: "diouxXDOUeEfFgGaAcCsSp". +Each directive +is matched by one of more arguments to the +.Xr xo_emit 3 +function. +.Pp +The format string has the form: +.Bd -literal -offset indent + \(aq%\(aq format\-modifier * format\-character +.Ed +.Pp +The format\-modifier can be: +.Bl -bullet +.It +a \(aq#\(aq character, indicating the output value should be prefixed with +"0x", typically to indicate a base 16 (hex) value. +.It +a minus sign (\(aq\-\(aq), indicating the output value should be padded on +the right instead of the left. +.It +a leading zero (\(aq0\(aq) indicating the output value should be padded on the +left with zeroes instead of spaces (\(aq \(aq). +.It +one or more digits (\(aq0\(aq \- \(aq9\(aq) indicating the minimum width of the +argument. +If the width in columns of the output value is less than +the minimum width, the value will be padded to reach the minimum. +.It +a period followed by one or more digits indicating the maximum +number of bytes which will be examined for a string argument, or the maximum +width for a non\-string argument. +When handling ASCII strings this +functions as the field width but for multi\-byte characters, a single +character may be composed of multiple bytes. +.Xr xo_emit 3 +will never dereference memory beyond the given number of bytes. +.It +a second period followed by one or more digits indicating the maximum +width for a string argument. +This modifier cannot be given for non\-string arguments. +.It +one or more \(aqh\(aq characters, indicating shorter input data. +.It +one or more \(aql\(aq characters, indicating longer input data. +.It +a \(aqz\(aq character, indicating a \(aqsize_t\(aq argument. +.It +a \(aqt\(aq character, indicating a \(aqptrdiff_t\(aq argument. +.It +a \(aq \(aq character, indicating a space should be emitted before +positive numbers. +.It +a \(aq+\(aq character, indicating sign should emitted before any number. +.El +.Pp +Note that \(aqq\(aq, \(aqD\(aq, \(aqO\(aq, and \(aqU\(aq are considered deprecated and will be +removed eventually. +.Pp +The format character is described in the following table: +.Bl -column C "Argument Type12" +.It Sy "C" "Argument Type " "Format" +.It d "int " "base 10 (decimal)" +.It i "int " "base 10 (decimal)" +.It o "int " "base 8 (octal)" +.It u "unsigned " "base 10 (decimal)" +.It x "unsigned " "base 16 (hex)" +.It X "unsigned long " "base 16 (hex)" +.It D "long " "base 10 (decimal)" +.It O "unsigned long " "base 8 (octal)" +.It U "unsigned long " "base 10 (decimal)" +.It e "double " "[\-]d.ddde+\-dd" +.It E "double " "[\-]d.dddE+\-dd" +.It f "double " "[\-]ddd.ddd" +.It F "double " "[\-]ddd.ddd" +.It g "double " "as \(aqe\(aq or \(aqf\(aq" +.It G "double " "as \(aqE\(aq or \(aqF\(aq" +.It a "double " "[\-]0xh.hhhp[+\-]d" +.It A "double " "[\-]0Xh.hhhp[+\-]d" +.It c "unsigned char " "a character" +.It C "wint_t " "a character" +.It s "char * " "a UTF\-8 string" +.It S "wchar_t * " "a unicode/WCS string" +.It p "void * " "\(aq%#lx\(aq" +.El +.Pp +The \(aqh\(aq and \(aql\(aq modifiers affect the size and treatment of the +argument: +.Bl -column "Mod" "d, i " "o, u, x, X " +.It Sy "Mod" "d, i " "o, u, x, X" +.It "hh " "signed char " "unsigned char" +.It "h " "short " "unsigned short" +.It "l " "long " "unsigned long" +.It "ll " "long long " "unsigned long long" +.It "j " "intmax_t " "uintmax_t" +.It "t " "ptrdiff_t " "ptrdiff_t" +.It "z " "size_t " "size_t" +.It "q " "quad_t " "u_quad_t" +.El +.Ss "UTF\-8 and Locale Strings" +All strings for +.Nm libxo +must be UTF\-8. +.Nm libxo +will handle turning them +into locale\-based strings for display to the user. +.Pp +For strings, the \(aqh\(aq and \(aql\(aq modifiers affect the interpretation of +the bytes pointed to argument. +The default \(aq%s\(aq string is a \(aqchar *\(aq +pointer to a string encoded as UTF\-8. +Since UTF\-8 is compatible with +.Em ASCII +data, a normal 7\-bit +.Em ASCII +string can be used. +"%ls" expects a +"wchar_t *" pointer to a wide\-character string, encoded as 32\-bit +Unicode values. +"%hs" expects a "char *" pointer to a multi\-byte +string encoded with the current locale, as given by the +.Ev LC_CTYPE , +.Ev LANG , +or +.Ev LC_ALL +environment variables. +The first of this list of +variables is used and if none of the variables are set, the locale defaults to +.Em UTF\-8 . +.Pp +.Nm libxo +will +convert these arguments as needed to either UTF\-8 (for XML, JSON, and +HTML styles) or locale\-based strings for display in text style. +.Bd -literal -offset indent + xo_emit("All strings are utf\-8 content {:tag/%ls}", + L"except for wide strings"); +.Ed +.Pp +"%S" is equivalent to "%ls". +.Pp +For example, a function is passed a locale\-base name, a hat size, +and a time value. +The hat size is formatted in a UTF\-8 (ASCII) +string, and the time value is formatted into a wchar_t string. +.Bd -literal -offset indent + void print_order (const char *name, int size, + struct tm *timep) { + char buf[32]; + const char *size_val = "unknown"; + + if (size > 0) + snprintf(buf, sizeof(buf), "%d", size); + size_val = buf; + } + + wchar_t when[32]; + wcsftime(when, sizeof(when), L"%d%b%y", timep); + + xo_emit("The hat for {:name/%hs} is {:size/%s}.\\n", + name, size_val); + xo_emit("It was ordered on {:order\-time/%ls}.\\n", + when); + } +.Ed +.Pp +It is important to note that +.Xr xo_emit 3 +will perform the conversion +required to make appropriate output. +Text style output uses the +current locale (as described above), while XML, JSON, and HTML use +UTF\-8. +.Pp +UTF\-8 and locale\-encoded strings can use multiple bytes to encode one +column of data. +The traditional "precision" (aka "max\-width") value +for "%s" printf formatting becomes overloaded since it specifies both +the number of bytes that can be safely referenced and the maximum +number of columns to emit. +.Xr xo_emit 3 +uses the precision as the former, +and adds a third value for specifying the maximum number of columns. +.Pp +In this example, the name field is printed with a minimum of 3 columns +and a maximum of 6. +Up to ten bytes are in used in filling those columns. +.Bd -literal -offset indent + xo_emit("{:name/%3.10.6s}", name); +.Ed +.Ss "Characters Outside of Field Definitions" +Characters in the format string that are not part of a field definition are +copied to the output for the TEXT style, and are ignored for the JSON +and XML styles. +For HTML, these characters are placed in a <div> with class "text". +.Bd -literal -offset indent + EXAMPLE: + xo_emit("The hat is {:size/%s}.\\n", size_val); + TEXT: + The hat is extra small. + XML: + <size>extra small</size> + JSON: + "size": "extra small" + HTML: + <div class="text">The hat is </div> + <div class="data" data\-tag="size">extra small</div> + <div class="text">.</div> +.Ed +.Ss "\(aq%n\(aq is Not Supported" +.Nm libxo +does not support the \(aq%n\(aq directive. +It is a bad idea and we +just do not do it. +.Ss "The Encoding Format (eformat)" +The "eformat" string is the format string used when encoding the field +for JSON and XML. +If not provided, it defaults to the primary format +with any minimum width removed. +If the primary is not given, both default to "%s". +.Sh EXAMPLE +In this example, the value for the number of items in stock is emitted: +.Bd -literal -offset indent + xo_emit("{P: }{Lwc:In stock}{:in\-stock/%u}\\n", + instock); +.Ed +.Pp +This call will generate the following output: +.Bd -literal -offset indent + TEXT: + In stock: 144 + XML: + <in\-stock>144</in\-stock> + JSON: + "in\-stock": 144, + HTML: + <div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data\-tag="in\-stock">144</div> + </div> +.Ed +.Pp +Clearly HTML wins the verbosity award, and this output does +not include +.Dv XOF_XPATH +or +.Dv XOF_INFO +data, which would expand the penultimate line to: +.Bd -literal -offset indent + <div class="data" data\-tag="in\-stock" + data\-xpath="/top/data/item/in\-stock" + data\-type="number" + data\-help="Number of items in stock">144</div> +.Ed +.Sh WHAT MAKES A GOOD FIELD NAME? +To make useful, consistent field names, follow these guidelines: +.Ss "Use lower case, even for TLAs" +Lower case is more civilized. +Even TLAs should be lower case +to avoid scenarios where the differences between "XPath" and +"Xpath" drive your users crazy. +Using "xpath" is simpler and better. +.Ss "Use hyphens, not underscores" +Use of hyphens is traditional in XML, and the +.Dv XOF_UNDERSCORES +flag can be used to generate underscores in JSON, if desired. +But the raw field name should use hyphens. +.Ss "Use full words" +Do not abbreviate especially when the abbreviation is not obvious or +not widely used. +Use "data\-size", not "dsz" or "dsize". +Use +"interface" instead of "ifname", "if\-name", "iface", "if", or "intf". +.Ss "Use <verb>\-<units>" +Using the form <verb>\-<units> or <verb>\-<classifier>\-<units> helps in +making consistent, useful names, avoiding the situation where one app +uses "sent\-packet" and another "packets\-sent" and another +"packets\-we\-have\-sent". +The <units> can be dropped when it is +obvious, as can obvious words in the classification. +Use "receive\-after\-window\-packets" instead of +"received\-packets\-of\-data\-after\-window". +.Ss "Reuse existing field names" +Nothing is worse than writing expressions like: +.Bd -literal -offset indent + if ($src1/process[pid == $pid]/name == + $src2/proc\-table/proc/p[process\-id == $pid]/proc\-name) { + ... + } +.Ed +.Pp +Find someone else who is expressing similar data and follow their +fields and hierarchy. +Remember the quote is not +.Dq "Consistency is the hobgoblin of little minds" +but +.Dq "A foolish consistency is the hobgoblin of little minds" . +.Ss "Think about your users" +Have empathy for your users, choosing clear and useful fields that +contain clear and useful data. +You may need to augment the display content with +.Xr xo_attr 3 +calls or "{e:}" fields to make the data useful. +.Ss "Do not use an arbitrary number postfix" +What does "errors2" mean? +No one will know. +"errors\-after\-restart" would be a better choice. +Think of your users, and think of the future. +If you make "errors2", the next guy will happily make +"errors3" and before you know it, someone will be asking what is the +difference between errors37 and errors63. +.Ss "Be consistent, uniform, unsurprising, and predictable" +Think of your field vocabulary as an API. +You want it useful, +expressive, meaningful, direct, and obvious. +You want the client +application\(aqs programmer to move between without the need to +understand a variety of opinions on how fields are named. +They should +see the system as a single cohesive whole, not a sack of cats. +.Pp +Field names constitute the means by which client programmers interact +with our system. +By choosing wise names now, you are making their lives better. +.Pp +After using +.Xr xolint 1 +to find errors in your field descriptors, use +.Dq "xolint \-V" +to spell check your field names and to detect different +names for the same data. +.Dq dropped\-short +and +.Dq dropped\-too\-short +are both reasonable names, but using them both will lead users to ask the +difference between the two fields. +If there is no difference, +use only one of the field names. +If there is a difference, change the +names to make that difference more obvious. +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xolint 1 , +.Xr xo_emit 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_humanize.h b/contrib/libxo/libxo/xo_humanize.h new file mode 100644 index 000000000000..edf85b8bb1ba --- /dev/null +++ b/contrib/libxo/libxo/xo_humanize.h @@ -0,0 +1,169 @@ +/* $NetBSD: humanize_number.c,v 1.8 2004/07/27 01:56:24 enami Exp $ */ + +/* + * Copyright (c) 1997, 1998, 1999, 2002 The NetBSD Foundation, Inc. + * All rights reserved. + * + * This code is derived from software contributed to The NetBSD Foundation + * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, + * NASA Ames Research Center, by Luke Mewburn and by Tomas Svensson. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by the NetBSD + * Foundation, Inc. and its contributors. + * 4. Neither the name of The NetBSD Foundation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS + * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS + * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#include <sys/cdefs.h> + +#include <sys/types.h> +#include <assert.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <locale.h> +#include <stdint.h> +#include <limits.h> +#include <unistd.h> +#include <stdbool.h> + +/* humanize_number(3) */ +#define HN_DECIMAL 0x01 +#define HN_NOSPACE 0x02 +#define HN_B 0x04 +#define HN_DIVISOR_1000 0x08 + +#define HN_GETSCALE 0x10 +#define HN_AUTOSCALE 0x20 + +static int +xo_humanize_number (char *buf, size_t len, int64_t bytes, + const char *suffix, int scale, int flags) +{ + const char *prefixes, *sep; + int b, i, r, maxscale, s1, s2, sign; + int64_t divisor, max; + // We multiply bytes by 100 to deal with rounding, so we need something + // big enough to hold LLONG_MAX * 100. On 64-bit we can use 128-bit wide + // integers with __int128_t, but on 32-bit we have to use long double. +#ifdef __LP64__ + __int128_t scalable = (__int128_t)bytes; +#else + long double scalable = (long double)bytes; +#endif + size_t baselen; + + assert(buf != NULL); + assert(suffix != NULL); + assert(scale >= 0); + + if (flags & HN_DIVISOR_1000) { + /* SI for decimal multiplies */ + divisor = 1000; + if (flags & HN_B) + prefixes = "B\0k\0M\0G\0T\0P\0E"; + else + prefixes = "\0\0k\0M\0G\0T\0P\0E"; + } else { + /* + * binary multiplies + * XXX IEC 60027-2 recommends Ki, Mi, Gi... + */ + divisor = 1024; + if (flags & HN_B) + prefixes = "B\0K\0M\0G\0T\0P\0E"; + else + prefixes = "\0\0K\0M\0G\0T\0P\0E"; + } + +#define SCALE2PREFIX(scale) (&prefixes[(scale) << 1]) + maxscale = 7; + + if (scale >= maxscale && + (scale & (HN_AUTOSCALE | HN_GETSCALE)) == 0) + return (-1); + + if (buf == NULL || suffix == NULL) + return (-1); + + if (len > 0) + buf[0] = '\0'; + if (bytes < 0) { + sign = -1; + scalable *= -100; + baselen = 3; /* sign, digit, prefix */ + } else { + sign = 1; + scalable *= 100; + baselen = 2; /* digit, prefix */ + } + if (flags & HN_NOSPACE) + sep = ""; + else { + sep = " "; + baselen++; + } + baselen += strlen(suffix); + + /* Check if enough room for `x y' + suffix + `\0' */ + if (len < baselen + 1) + return (-1); + + if (scale & (HN_AUTOSCALE | HN_GETSCALE)) { + /* See if there is additional columns can be used. */ + for (max = 100, i = len - baselen; i-- > 0;) + max *= 10; + + for (i = 0; scalable >= max && i < maxscale; i++) + scalable /= divisor; + + if (scale & HN_GETSCALE) + return (i); + } else + for (i = 0; i < scale && i < maxscale; i++) + scalable /= divisor; + + /* If a value <= 9.9 after rounding and ... */ + if (scalable < 995 && i > 0 && flags & HN_DECIMAL) { + /* baselen + \0 + .N */ + if (len < baselen + 1 + 2) + return (-1); + b = ((int)scalable + 5) / 10; + s1 = b / 10; + s2 = b % 10; + r = snprintf(buf, len, "%s%d%s%d%s%s%s", + ((sign == -1) ? "-" : ""), + s1, localeconv()->decimal_point, s2, + sep, SCALE2PREFIX(i), suffix); + } else + r = snprintf(buf, len, "%s%lld%s%s%s", + /* LONGLONG */ + ((sign == -1) ? "-" : ""), + (long long)((scalable + 50) / 100), + sep, SCALE2PREFIX(i), suffix); + + return (r); +} diff --git a/contrib/libxo/libxo/xo_message.3 b/contrib/libxo/libxo/xo_message.3 new file mode 100644 index 000000000000..ce979a51dc95 --- /dev/null +++ b/contrib/libxo/libxo/xo_message.3 @@ -0,0 +1,78 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_message , xo_message_c , xo_message_hc , xo_message_hcv +.Nd emit messages in multiple output styles +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_message "const char *fmt" "..." +.Ft void +.Fn xo_message_e "const char *fmt" "..." +.Ft void +.Fn xo_message_c "int code" "const char *fmt" "..." +.Ft void +.Fn xo_message_hc "xo_handle_t *xop" "int code, const char *fmt" "..." +.Ft void +.Fn xo_message_hcv "xo_handle_t *xop" "int code" "const char *fmt" "va_list vap" +.Sh DESCRIPTION +.Nm xo_message +generates text message which lack any sort of structure. +These functions should not be used under normal conditions, since +they completely defeat the value of using libxo. They are provided +for scenarios when the output's content is genuinely unknown and +unusable. +It is used in converting programs where err/warn where not used, +and error messages went to +.Nm stdout , +not +.Nm stderr . +Use of +.Nm xo_message +allows backwards compatibility with that output, but does not put +the error in a useful form. +.Pp +The +.Nm xo_message +function generates output strings using the printf-style format string +and arguments provided. +If the format string does not end in a newline, +.Nm xo_message_e +will appear a colon, a space, and the error associated with the current +.Nm errno +value. +.Nm xo_message_c behaves similarly for the value passed in the +.Fa code +parameter. +.Nm xo_message_hc +accepts a +.Fa handle +as opened by +.Xr xo_create 3 +and +.Nm xo_message_hcv accepts a va_list parameter of arguments. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_no_setlocale.3 b/contrib/libxo/libxo/xo_no_setlocale.3 new file mode 100644 index 000000000000..da3e8a343fab --- /dev/null +++ b/contrib/libxo/libxo/xo_no_setlocale.3 @@ -0,0 +1,53 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_no_setlocale +.Nd prevent implicit call to setlocale +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_no_setlocale "void" +.Sh DESCRIPTION +.Nm libxo +automatically initializes the locale based on the setting of the +environment variables +.Ev LC_CTYPE , +.Ev LANG , +and +.Ev LC_ALL . +The first of this +list of variables is used and if none of the variables are set, the locale +defaults to +.Em UTF-8 . +The caller may wish to avoid this behavior, and +can do so by calling the +.Fn xo_no_setlocale +function. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr xo_open_container 3 , +.Xr xo_open_list 3 , +.Xr xo_format 5 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_open_container.3 b/contrib/libxo/libxo/xo_open_container.3 new file mode 100644 index 000000000000..303f3f06fd02 --- /dev/null +++ b/contrib/libxo/libxo/xo_open_container.3 @@ -0,0 +1,198 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_open_container , xo_open_container_h , xo_open_container_hd , xo_open_container_d +.Nm xo_close_container , xo_close_container_h , xo_close_container_hd , xo_close_container_d +.Nd open (and close) container constructs +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_open_container "const char *name" +.Ft xo_ssize_t +.Fn xo_open_container_h "xo_handle_t *handle" "const char *name" +.Ft xo_ssize_t +.Fn xo_open_container_hd "xo_handle_t *handle" "const char *name" +.Ft xo_ssize_t +.Fn xo_open_container_d "const char *name" +.Ft xo_ssize_t +.Fn xo_close_container "const char *name" +.Ft xo_ssize_t +.Fn xo_close_container_h "xo_handle_t *handle" "const char *name" +.Ft xo_ssize_t +.Fn xo_close_container_hd "xo_handle_t *handle" +.Ft xo_ssize_t +.Fn xo_close_container_d "void" +.Sh DESCRIPTION +.Nm libxo +represents two types of hierarchy: +.Dq containers +and +.Dq lists . +A container appears once under a given parent where a list contains +instances that can appear multiple times. +A container is used to hold +related fields and to give the data organization and scope. +The container has no value, but serves to +contain other nodes. +.Pp +To open a container, call +.Fn xo_open_container +or +.Fn xo_open_container_h . +The former uses the default handle and +the latter accepts a specific handle. +.Pp +To close a level, use the +.Fn xo_close_container +or +.Fn xo_close_container_h +functions. +.Pp +Each open call should have a matching close call. +If the +.Dv XOF_WARN +flag is set and the name given does not match the name of +the currently open +container, a warning will be generated. +.Bd -literal -offset indent -compact + Example: + + xo_open_container("top"); + xo_open_container("system"); + xo_emit("{:host-name/%s%s%s", hostname, + domainname ? "." : "", domainname ?: ""); + xo_close_container("system"); + xo_close_container("top"); + + Sample Output: + Text: + my-host.example.org + XML: + <top> + <system> + <host-name>my-host.example.org</host-name> + </system> + </top> + JSON: + "top" : { + "system" : { + "host-name": "my-host.example.org" + } + } + HTML: + <div class="data" + data-tag="host-name">my-host.example.org</div> +.Ed +.Sh EMITTING HIERARCHY +To create a container, use the +.Fn xo_open_container +and +.Fn xo_close_container +set of functions. +The +.Fa handle +parameter contains a handle such as returned by +.Xr xo_create 3 +or +.Dv NULL +to use the default handle. +The +.Fa name +parameter gives the name of the container, encoded in +.Em UTF-8 . +Since +.Em ASCII +is a proper subset of +.Em UTF-8 , +traditional C strings can be used directly. +.Pp +The close functions with the +.Dq _d +suffix are used in +.Dq "Do The Right Thing" +mode, where the name of the open containers, lists, and +instances are maintained internally by +.Nm libxo +to allow the caller to +avoid keeping track of the open container name. +.Pp +Use the +.Dv XOF_WARN +flag to generate a warning if the name given on the +close does not match the current open container. +.Pp +For TEXT and HTML output, containers are not rendered into output +text, though for HTML they are used when the +.Dv XOF_XPATH +flag is set. +.Pp +.Bd -literal -offset indent -compact + EXAMPLE: + xo_open_container("system"); + xo_emit("The host name is {:host-name}\\n", hn); + xo_close_container("system"); + XML: + <system><host-name>foo</host-name></system> +.Ed +.Sh DTRT MODE +Some users may find tracking the names of open containers, lists, and +instances inconvenient. +.Nm libxo +offers a +.Dq "Do The Right Thing" +mode, where +.Nm libxo +will track the names of open containers, lists, and instances so +the close function can be called without a name. +To enable +.Em DTRT +mode, +turn on the +.Dv XOF_DTRT +flag prior to making any other +.Nm libxo +output. +.Bd -literal -offset indent -compact + xo_set_flags(NULL, XOF_DTRT); +.Ed +Each open and close function has a version with the suffix +.Dq _d , +which will close the open container, list, or instance: +.Bd -literal -offset indent -compact + xo_open_container("top"); + ... + xo_close_container_d(); +.Ed +Note that the +.Dv XOF_WARN +flag will also cause +.Nm libxo +to track open +containers, lists, and instances. +A warning is generated when the name given to the close function +and the name recorded do not match. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_open_list.3 b/contrib/libxo/libxo/xo_open_list.3 new file mode 100644 index 000000000000..e61e15939c87 --- /dev/null +++ b/contrib/libxo/libxo/xo_open_list.3 @@ -0,0 +1,168 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_open_list , xo_open_list_h , xo_open_list_hd , xo_open_list_d +.Nm xo_open_instance , xo_open_instance_h , xo_open_instance_hd , xo_open_instance_d +.Nm xo_close_instance , xo_close_instance_h , xo_close_instance_hd , xo_close_instance_d +.Nm xo_close_list , xo_close_list_h , xo_close_list_hd , xo_close_list_d +.Nd open and close lists and instances +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_open_list_h "xo_handle_t *xop" "const char *name" +.Ft xo_ssize_t +.Fn xo_open_list "const char *name" +.Ft xo_ssize_t +.Fn xo_open_list_hd "xo_handle_t *xop" "const char *name" +.Ft xo_ssize_t +.Fn xo_open_list_d "const char *name" +.Ft xo_ssize_t +.Fn xo_open_instance_h "xo_handle_t *xop" "const char *name" +.Ft xo_ssize_t +.Fn xo_open_instance "const char *name" +.Ft xo_ssize_t +.Fn xo_open_instance_hd "xo_handle_t *xop" "const char *name" +.Ft xo_ssize_t +.Fn xo_open_instance_d "const char *name" +.Ft xo_ssize_t +.Fn xo_close_instance_h "xo_handle_t *xop" "const char *name" +.Ft xo_ssize_t +.Fn xo_close_instance "const char *name" +.Ft xo_ssize_t +.Fn xo_close_instance_hd "xo_handle_t *xop" +.Ft xo_ssize_t +.Fn xo_close_instance_d "void" +.Ft xo_ssize_t +.Fn xo_close_list_h "xo_handle_t *xop" "const char *name" +.Ft xo_ssize_t +.Fn xo_close_list "const char *name" +.Ft xo_ssize_t +.Fn xo_close_list_hd "xo_handle_t *xop" +.Ft xo_ssize_t +.Fn xo_close_list_d "void" +.Sh DESCRIPTION +Lists are sequences of instances of homogeneous data objects. +Two +distinct levels of calls are needed to represent them in our output +styles. +Calls must be made to open and close a list, and for each +instance of data in that list, calls must be make to open and close +that instance. +.Pp +The name given to all calls must be identical, and it is strongly +suggested that the name be singular, not plural, as a matter of +style and usage expectations. +.Pp +A list is a set of one or more instances that appear under the same +parent. +The instances contain details about a specific object. +One can think of instances as objects or records. +A call is needed to +open and close the list, while a distinct call is needed to open and +close each instance of the list: +.Bd -literal -offset indent -compact + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + xo_emit("{L:Item} '{:name/%s}':\\n", ip->i_title); + xo_close_instance("item"); + } + + xo_close_list("item"); +.Ed +Getting the list and instance calls correct is critical to the proper +generation of XML and JSON data. +.Pp +.Bd -literal -offset indent -compact + EXAMPLE: + xo_open_list("user"); + for (i = 0; i < num_users; i++) { + xo_open_instance("user"); + xo_emit("{k:name}:{:uid/%u}:{:gid/%u}:{:home}\\n", + pw[i].pw_name, pw[i].pw_uid, + pw[i].pw_gid, pw[i].pw_dir); + xo_close_instance("user"); + } + xo_close_list("user"); + TEXT: + phil:1001:1001:/home/phil + pallavi:1002:1002:/home/pallavi + XML: + <user> + <name>phil</name> + <uid>1001</uid> + <gid>1001</gid> + <home>/home/phil</home> + </user> + <user> + <name>pallavi</name> + <uid>1002</uid> + <gid>1002</gid> + <home>/home/pallavi</home> + </user> + JSON: + user: [ + { + "name": "phil", + "uid": 1001, + "gid": 1001, + "home": "/home/phil", + }, + { + "name": "pallavi", + "uid": 1002, + "gid": 1002, + "home": "/home/pallavi", + } + ] +.Ed +.Pp +.Sh LEAF LISTS +In contrast to a list of instances, a "leaf list" is list of simple +values. +To emit a leaf list, call the +.Fn xo_emit +function using the ""l"" modifier: +.Bd -literal -offset indent -compact + for (ip = list; ip->i_title; ip++) { + xo_emit("{Lwc:Item}{l:item}\\n", ip->i_title); + } +.Ed +.Pp +The name of the field must match the name of the leaf list. +.Pp +In JSON, leaf lists are rendered as arrays of values. In XML, they +are rendered as multiple leaf elements. +.Bd -literal -offset indent -compact + JSON: + "item": "hammer", "nail" + XML: + <item>hammer</item> + <item>nail</item> +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_open_marker.3 b/contrib/libxo/libxo/xo_open_marker.3 new file mode 100644 index 000000000000..7c252f3d620f --- /dev/null +++ b/contrib/libxo/libxo/xo_open_marker.3 @@ -0,0 +1,115 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, January 2015 +.\" +.Dd January 22, 2015 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_open_marker , xo_open_marker_h , xo_close_marker , xo_close_marker_h +.Nd prevent and allow closing of open constructs +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft xo_ssize_t +.Fn xo_open_marker "const char *name" +.Ft xo_ssize_t +.Fn xo_open_marker_h "xo_handle_t *handle" "const char *name" +.Ft xo_ssize_t +.Fn xo_close_marker "const char *name" +.Ft xo_ssize_t +.Fn xo_close_marker_h "xo_handle_t *handle" "const char *name" +.Sh DESCRIPTION +.Nm libxo +represents hierarchy using two constructs: +.Dq containers +and +.Dq lists . +A marker can be used to affect how open constructs are closed, either +by preventing their (implicit or explicit) closure or by forcing their +closure. +While a marker is open, no other open constructs can be closed. +When a marker is closed, all constructs open since the marker was opened +will be closed. +A marker is used to "freeze" any open constructs. +Calls to +.Fn xo_close_* +functions that would normally close them will be ignored, effectively +blocking their closure. +However when +.Fn xo_close_marker +is called, any containers, lists, or leaf-lists open since the +matching +.Fn xo_open_marker +call will be close and the marker discarded. +Markers use names which are not user-visible, allowing the caller to +choose appropriate internal names. +The marker has no value and is not emitted in any form. +.Pp +To open a marker, call +.Fn xo_open_marker +or +.Fn xo_open_marker_h . +The former uses the default handle and +the latter accepts a specific handle. +.Pp +To close a marker, use the +.Fn xo_close_marker +or +.Fn xo_close_marker_h +functions. +.Pp +Each open call must have a matching close call. +.Pp +In this example, the +.Fn xo_close_container +call on line [1] will be ignored, since the open marker "outer" +will prevent close of any open constructs that precede it. +The +.Fn xo_close_marker +call on line [2] will close the "system" container, since it was +opened after the "outer" marker. +.Bd -literal -offset indent -compact + Example: + + xo_open_container("top"); + xo_open_marker("outer"); + xo_open_container("system"); + xo_emit("{:host-name/%s%s%s", hostname, + domainname ? "." : "", domainname ?: ""); + xo_close_container("top"); /* [1] */ + xo_close_marker("outer"); /* [2] */ + xo_close_container("top"); +.Ed +.Pp +In this example, the code whiffles through a list of fish, calling a +function to emit details about each fish. The marker "fish-guts" is +used to ensure that any constructs opened by the function are closed +properly. +.Bd -literal -offset indent + for (i = 0; fish[i]; i++) { + xo_open_instance("fish"); + xo_open_marker("fish-guts"); + dump_fish_details(i); + xo_close_marker("fish-guts"); + } +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_options.7 b/contrib/libxo/libxo/xo_options.7 new file mode 100644 index 000000000000..297dcba92a41 --- /dev/null +++ b/contrib/libxo/libxo/xo_options.7 @@ -0,0 +1,156 @@ +.\" # +.\" # Copyright (c) 2014-2017, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd May 11, 2017 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_options +.Nd common options for libxo\-based commands +.Sh DESCRIPTION +.Pp +.Nm libxo +allows the rendering of data into +various output styles, including +.Em text , +.Em XML , +.Em JSON , +and +.Em HTML . +.Nm libxo +uses command line options to trigger rendering behavior. +Options are recognised in three forms: +.Bl -bullet +.It +\-\-libxo <options> +.It +\-\-libxo=<options> +.It +\-\-libxo:<brief\-options> +.El +.Pp +The first two forms accept a comma\-separated set of words, detailed +below, while the third form accepts a set of letters, also below. +The triggered functionality is identical. +.Bl -column "Token2341234" +.It Sy "Option " "Action" +.It "color " "Enable colors/effects for display styles (TEXT, HTML)" +.It "flush " "Flush after each emit call" +.It "flush\-line " "Flush each line of output" +.It "html " "Emit HTML output" +.It "indent=xx " "Set the indentation level" +.It "info " "Add info attributes (HTML)" +.It "json " "Emit JSON output" +.It "keys " "Emit the key attribute for keys (XML)" +.It "log\-gettext" "Log (via stderr) each gettext(3) string lookup" +.It "log\-syslog " "Log (via stderr) each syslog message (via xo_syslog)" +.It "no\-humanize" "Ignore the {h:} modifier (TEXT, HTML)" +.It "no\-locale " "Do not initialize the locale setting" +.It "no\-retain " "Prevent retaining formatting information" +.It "pretty " "Emit pretty\-printed output" +.It "retain " "Force retaining formatting information" +.It "text " "Emit TEXT output" +.It "underscores" "Replace XML\-friendly \"\-\"s with JSON friendly \"_\"s" +.It "units " "Add the 'units' (XML) or 'data\-units (HTML) attribute" +.It "warn " "Emit warnings when libxo detects bad calls" +.It "warn\-xml " "Emit warnings in XML" +.It "xml " "Emit XML output" +.It "xpath " "Add XPath expressions (HTML)" +.El +.Pp +The brief options are a set of single\-letter aliases for the longer +terms, used as a single string: +.Bl -column "Value" "Equivalent Token" +.It Sy "Value" "Equivalent Token" +.It "c +.It "f " "flush" +.It "F " "flush\-line" +.It "H " "html" +.It "I " "info" +.It "i<num>" "indent=<num>" +.It "J " "json" +.It "k " "keys" +.It "n " "no\-humanize" +.It "P " "pretty" +.It "T " "text" +.It "U " "units" +.It "u " "underscore +.It "W " "warn" +.It "X " "xml" +.It "x " "xpath" +.El +.Pp +Most of these option are simple and direct, but some require +additional details: +.Pp +.Fa "flush\-line" +performs line buffering, even when the output is not directed to +a TTY device. +.Pp +.Fa info +generates additional data for HTML, encoded in attributes using +names that state with "data\-". +.Pp +.Fa keys +adds a "key" attribute for XML output to indicate that a leaf is +an identifier for the list member. +.Pp +.Fa no\-humanize +avoids "humanizing" numeric output (see +.Xr humanize_number 3 +for details). +.Pp +.Fa no\-locale +instructs +.Nm libxo +to avoid translating output to the current locale. +.Pp +.Fa no\-retain +disables the ability of +.Nm libxo +to internally retain "compiled" information about formatting strings. +.Pp +.Fa underscores +can be used with +.Em JSON +output to change +.Em XML \-friendly +names with dashes into +.Em JSON \-friendly +name with underscores. +.Pp +.Fa warn +allows +.Nm libxo +to emit warnings on stderr when application code make incorrect calls. +.Fa warn\-xml causes those warnings to be placed in +.Em XML +inside the output. +.Sh EXAMPLES +The following are three example invocations of +.Xr ps 1 : +.Bd -literal + ps \-\-libxo json,pretty,warn \-ux + + ps \-\-libxo=xml \-lg + + ps \-\-libxo:Hxc 1 +.Ed +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xo_format 5 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . diff --git a/contrib/libxo/libxo/xo_parse_args.3 b/contrib/libxo/libxo/xo_parse_args.3 new file mode 100644 index 000000000000..e631af639e07 --- /dev/null +++ b/contrib/libxo/libxo/xo_parse_args.3 @@ -0,0 +1,80 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd November 17, 2020 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_parse_args , xo_set_program +.Nd detect, parse, and remove arguments for libxo +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft int +.Fn xo_parse_args "int argc" "char **argv" +.Ft int +.Fn xo_set_program "const char *name" +.Sh DESCRIPTION +The +.Fn xo_parse_args +function is used to process command-line arguments, which are +described in +.Xr xo_options 7 . +.Nm libxo +specific +options are processed and removed +from the argument list so the calling application does not +need to process them. +If successful, a new value for argc is returned. +On failure, a message it emitted and -1 is returned. +.Bd -literal -offset indent + argc = xo_parse_args(argc, argv); + if (argc < 0) + exit(EXIT_FAILURE); +.Ed +.Pp +Following the call to +.Fn xo_parse_args , +the application can process the remaining arguments in a normal manner. +.Pp +The +.Fn xo_set_program +function sets name of the program as reported by +functions like +.Fn xo_failure , +.Fn xo_warn , +.Fn xo_err , +etc. +The program name is initialized by +.Fn xo_parse_args , +but subsequent calls to +.Fn xo_set_program +can override this value. +.Pp +Note that the value is not copied, so the memory passed to +.Fn xo_set_program +(and +.Fn xo_parse_args ) +must be maintained by the caller. +.Pp +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr xo_options 7, +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_allocator.3 b/contrib/libxo/libxo/xo_set_allocator.3 new file mode 100644 index 000000000000..c0e731ec2131 --- /dev/null +++ b/contrib/libxo/libxo/xo_set_allocator.3 @@ -0,0 +1,64 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_allocator +.Nd set allocation functions for libxo +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Sy typedef void *(*xo_realloc_func_t)(void *, size_t); +.Pp +.Sy typedef void (*xo_free_func_t)(void *); +.Ft void +.Fn xo_set_allocator "xo_realloc_func_t realloc_func" "xo_free_func_t free_func" +.Sh DESCRIPTION +The +.Fn xo_set_allocator +function allows +.Nm libxo +to be used in environments +where the standard +.Xr realloc 3 +and +.Xr free 3 +functions are not available. +.Pp +.Fa realloc_func +should expect the same arguments as +.Xr realloc 3 +and return +a pointer to memory following the same convention. +.Fa free_func +will receive the same argument as +.Xr free 3 +and should release it, as appropriate for the environment. +.Pp +By default, the standard +.Xr realloc 3 +and +.Xr free 3 +functions are used. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_flags.3 b/contrib/libxo/libxo/xo_set_flags.3 new file mode 100644 index 000000000000..a4c5754656cb --- /dev/null +++ b/contrib/libxo/libxo/xo_set_flags.3 @@ -0,0 +1,149 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_flags , xo_clear_flags +.Nd set operational flags for a libxo handle +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_set_flags "xo_handle_t *handle" "unsigned flags" +.Ft void +.Fn xo_clear_flags "xo_handle_t *handle" "xo_xof_flags_t flags" +.Sh DESCRIPTION +Use the +.Fn xo_set_flags +function to set the flags for a +.Nm libxo +handle. +To use the default handle, pass a +.Dv NULL +handle. +.Pp +The set of valid flags include: +.Bl -tag -width "XOF_UNDERSCORES" +.It Sy "Flag Description" +.It Dv XOF_CLOSE_FP +Close file pointer on +.Xr xo_destroy 3 . +This flag will trigger the call of the +.Fn close_func +(provided via +.Xr xo_set_writer 3 ) +when the handle is destroyed. +.It Dv XOF_COLOR +Enable color and effects in output regardless of output device. +.It Dv XOF_COLOR_ALLOWED +Allow color and effects if the output device is a terminal. +.It Dv XOF_INFO +Display info data attributes (HTML) +.It Dv XOF_KEYS +Emit the key attribute (XML) +.It Dv XOF_LOG_GETTEXT +Log (via stderr) each +.Xr gettext 3 +string lookup +.It Dv XOF_LOG_SYSLOG +Log (via stderr) each syslog message (via +.Xr xo_syslog 3 ) +.It Dv XOF_NO_ENV +Do not use the +.Ev LIBXO_OPTIONS +environment variable. +.It Dv XOF_PRETTY +Make 'pretty printed' output, with the +addition of indentation and newlines to enhance the readability of +XML, JSON, and HTML output. +Text output is not affected. +.It Dv XOF_UNDERSCORES +Replaces hyphens with underscores +.It Dv XOF_UNITS +Display units (XML and HMTL) +.It Dv XOF_WARN +Generate warnings for broken calls, triggering diagnostic +output (on standard error) when the library notices errors during +operations, or with arguments to functions. +Without warnings enabled, such conditions are ignored. +Warnings allow developers to debug their interaction with +.Nm libxo . +The function +.Fn xo_failure +can be used as a breakpoint for a debugger, +regardless of whether warnings are enabled. +.It Dv XOF_WARN_XML +Generate warnings in XML on stdout +.It Dv XOF_XPATH +Emit XPath expressions (HTML) +.It Dv XOF_COLUMNS +Force +.Xr xo_emit 3 +to return columns used +.It Dv XOF_FLUSH +Flush output after each +.Xr xo_emit 3 +call +.El +.Pp +If the style is +.Dv XO_STYLE_HTML , +the following additional flags can be +used: +.Bl -tag -width "XOF_UNDERSCORES" +.It Sy "Flag Description" +.It Dv XOF_XPATH +Emit "data-xpath" attributes +.It Dv XOF_INFO +Emit additional informational fields for HTML +output. +See +.Xr xo_set_info 3 +for details. +.El +.Pp +The +.Dv XOF_XPATH +flag enables the emission of XPath expressions detailing +the hierarchy of XML elements used to encode the data field, if the +XPATH style of output were requested. +.Pp +If the style is +.Dv XO_STYLE_XML , +the following additional flags can be +used: +.Bl -tag -width "XOF_UNDERSCORES" +.It Sy "Flag Description" +.It XOF_KEYS +Add 'key' attribute to the XML encoding for +field definitions that use the 'k' modifier. +The key attribute has +the value "key". +.El +.Pp +The +.Fn xo_clear_flags +function turns off the given flags in a specific +handle. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_info.3 b/contrib/libxo/libxo/xo_set_info.3 new file mode 100644 index 000000000000..c9c653f7597b --- /dev/null +++ b/contrib/libxo/libxo/xo_set_info.3 @@ -0,0 +1,112 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_info +.Nd set the field information data for libxo +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_set_info "xo_handle_t *handle" "xo_info_t *info" "int count" +.Sh DESCRIPTION +HTML data can include additional information in attributes that +begin with "data-". +To enable this, three things must occur: +.Pp +First the application must build an array of +.Dv xo_info_t +structures, +one per tag. +The array must be sorted by name, since +.Nm libxo +uses a +binary search to find the entry that matches names from format +instructions. +.Pp +The +.Dv xo_info_t +structure is defined in +.In libxo/xo.h : +.Bd -literal -offset indent + typedef struct xo_info_s { + const char *xi_name; /* Name of the element */ + const char *xi_type; /* Type of field */ + const char *xi_help; /* Description of field */ + } xo_info_t; +.Ed +.Pp +Second, the application must inform +.Nm libxo +about this information using the +.Fn xo_set_info +call. +Like other +.Nm libxo +calls, passing +.Dv NULL +for the handle tells +.Nm libxo +to use the default handle. +.Pp +If the +.Fa count +is -1, +.Nm libxo +will count the elements of +.Fa info , +but there +must be an empty element at the end. +More typically, the number is +known to the application: +.Bd -literal -offset indent + xo_info_t info[] = { + { "in-stock", "number", "Number of items in stock" }, + { "name", "string", "Name of the item" }, + { "on-order", "number", "Number of items on order" }, + { "sku", "string", "Stock Keeping Unit" }, + { "sold", "number", "Number of items sold" }, + }; + int info_count = (sizeof(info) / sizeof(info[0])); + ... + xo_set_info(NULL, info, info_count); +.Ed +.Pp +Third, the emission of info must be triggered with the +.Dv XOF_INFO +flag +using either the +.Fn xo_set_flags +function or the +.Dq --libxo=info +command line argument. +.Pp +The type and help values, if present, are emitted as the "data-type" +and "data-help" attributes: +.Bd -literal -offset indent + <div class="data" data-tag="sku" data-type="string" + data-help="Stock Keeping Unit">GRO-000-533</div> +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_options.3 b/contrib/libxo/libxo/xo_set_options.3 new file mode 100644 index 000000000000..bb44c9ca8207 --- /dev/null +++ b/contrib/libxo/libxo/xo_set_options.3 @@ -0,0 +1,41 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_options +.Nd change options used by a libxo handle +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft int +.Fn xo_set_options "xo_handle_t *xop" "const char *input" +.Sh DESCRIPTION +The +.Fn xo_set_options +function accepts a comma-separated list of styles +and flags and enables them for a specific handle. +The options are identical to those listed in +.Xr xo_parse_args 3 . +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_style.3 b/contrib/libxo/libxo/xo_set_style.3 new file mode 100644 index 000000000000..6cac9cdc5319 --- /dev/null +++ b/contrib/libxo/libxo/xo_set_style.3 @@ -0,0 +1,63 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_style , xo_set_style_name +.Nd set the output style for a libxo handle +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_set_style "xo_handle_t *handle" "unsigned style" +.Ft int +.Fn xo_set_style_name "xo_handle_t *handle" "const char *style" +.Sh DESCRIPTION +Use the +.Fn xo_set_style +function to set the output style for a handle. +To use the default handle, pass a +.Dv NULL +handle. +The set of output styles used by +.Nm libxo +is: +.Bl -column "XO_STYLE_TEXT12" +.It Sy "Flag Description" +.It "XO_STYLE_TEXT Traditional text output" +.It "XO_STYLE_XML XML encoded data" +.It "XO_STYLE_JSON JSON encoded data" +.It "XO_STYLE_HTML HTML encoded data" +.El +.Pp +The +.Fn xo_set_style_name +function can be used to set the style based on a name +encoded as a string. +The name can be any of the styles: "text", "xml", "json", or "html". +.Bd -literal -offset indent + EXAMPLE: + xo_set_style_name(NULL, "html"); +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_syslog_enterprise_id.3 b/contrib/libxo/libxo/xo_set_syslog_enterprise_id.3 new file mode 100644 index 000000000000..79eda02dd568 --- /dev/null +++ b/contrib/libxo/libxo/xo_set_syslog_enterprise_id.3 @@ -0,0 +1,46 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2015 +.\" +.Dd July 20, 2015 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_syslog_enterprise_id +.Nd Set the enterprise identifier for syslog content +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_set_syslog_enterprise_id "unsigned short eid" +.Ft void +.Sh DESCRIPTION +The +.Fn xo_set_syslog_enterprise_id +function records an enterprise identifier used for subsequent +.Xr xo_syslog 3 +calls. +Enterprise IDs are +defined by IANA, the Internet Assigned Numbers Authority: +.Bd -literal -offset indent +https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers +.Ed +.Sh SEE ALSO +.Xr xo_syslog 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_version.3 b/contrib/libxo/libxo/xo_set_version.3 new file mode 100644 index 000000000000..271d2357a200 --- /dev/null +++ b/contrib/libxo/libxo/xo_set_version.3 @@ -0,0 +1,44 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_version , xo_set_version_h +.Nd record content-version information in encoded output +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_set_version "const char *version" +.Ft void +.Fn xo_set_version_h "xo_handle_t *xop" "const char *version" +.Sh DESCRIPTION +The +.Nm xo_set_version +function records a version number to be emitted as +part of the data for encoding styles (XML and JSON). +This version number is suitable for tracking changes in the content, +allowing a user of the data to discern which version of the data model +is in use. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_set_writer.3 b/contrib/libxo/libxo/xo_set_writer.3 new file mode 100644 index 000000000000..f4f0a5dcb0d7 --- /dev/null +++ b/contrib/libxo/libxo/xo_set_writer.3 @@ -0,0 +1,66 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_writer +.Nd set custom writer functions for a libxo handle +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Sy typedef xo_ssize_t (*xo_write_func_t)(void *, const char *); +.Pp +.Sy typedef void (*xo_close_func_t)(void *); +.Pp +.Sy typedef int (*xo_flush_func_t)(void *); +.Fn xo_set_writer "xo_handle_t *handle" "void *opaque" + "xo_write_func_t write_func" + "xo_close_func_t close_func" + "xo_flush_func_t flush_func" +.Sh DESCRIPTION +The +.Fn xo_set_writer +function allows custom +.Dq write +functions +which can tailor how +.Nm libxo +writes data. +An +.Fa opaque +argument is +recorded and passed back to the +.Fa write_func +function, allowing the function +to acquire context information. +The +.Fa close_func +function can +release this opaque data and any other resources as needed. +The +.Fa flush_func +function should +flush any pending data associated with the opaque pointer. +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_syslog.3 b/contrib/libxo/libxo/xo_syslog.3 new file mode 100644 index 000000000000..c56c1dcc64c8 --- /dev/null +++ b/contrib/libxo/libxo/xo_syslog.3 @@ -0,0 +1,89 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2015 +.\" +.Dd July 20, 2015 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_syslog , xo_vsyslog , xo_open_log , xo_close_log , xo_set_logmask +.Nd create SYSLOG (RFC5424) log records using libxo formatting +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_syslog "int pri" "const char *name" "const char *fmt" "..." +.Ft void +.Fn xo_vsyslog "int pri" "const char *name" "const char *fmt" "va_list vap" +.Ft void +.Fn xo_close_log "void" +.Ft void +.Fn xo_open_log "const char *ident" "int logstat" "int logfac" +.Ft int +.Fn xo_set_logmask "int pmask" +.Sh DESCRIPTION +The +.Fn xo_syslog +function creates log entries following the standard defined in +RFC5424. +These messages are sent to the log +.Xr syslogd 8 +daemon, where they can be filtered, forwarded, and archived. +.Nm libxo +format strings are used to create both the message text and the +.Nm SD-PARAMS +content, containing name/value pairs that can be parsed by suitable +automation software. +.Pp +Refer to +.Xr xo_format 5 +for basic information about formatting strings. +.Nm xo_syslog +encodes all value fields at SD-PARAMS within the syslog message. +An exception is made for fields with the "{d:}" modifier; such fields +appear in the message text only, with fields with the "{e:}" modifier +appear as SD-PARAMS, but not in the message text. +.Pp +.Fn xo_vsyslog +accepts a +.Fa va_list +for additional flexibility. +.Pp +.Fn xo_open_log , +.Fn xo_close_log , and +.Fn xo_set_logmask +are all analogous to their libs counterparts, +.Xr openlog 3 , +.Xr closelog 3 , and +.Xr setlogmask 3 . +The extra underscores in the names are unfortunate, but keep +consistency in +.Nm libxo +function names. +.Sh EXAMPLES +.Bd -literal -offset indent + xo_syslog(LOG_LOCAL4 | LOG_NOTICE, "ID47", + "{e:iut/%u}An {:event-source} {:event-id/%u} log entry", + iut, source, id); +.Ed +.Sh SEE ALSO +.Xr xo_syslog 3 , +.Xr xo_set_syslog_enterprise_id 3 , +.Xr xo_format 5 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/libxo/xo_syslog.c b/contrib/libxo/libxo/xo_syslog.c new file mode 100644 index 000000000000..62da1811d0a5 --- /dev/null +++ b/contrib/libxo/libxo/xo_syslog.c @@ -0,0 +1,711 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, June 2015 + */ + +/* + * Portions of this file are: + * Copyright (c) 1983, 1988, 1993 + * The Regents of the University of California. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the University nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include <sys/cdefs.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <sys/syslog.h> +#include <sys/uio.h> +#include <sys/un.h> +#include <netdb.h> +#include <errno.h> +#include <fcntl.h> +#include <paths.h> +#include <pthread.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <time.h> +#include <limits.h> +#include <unistd.h> +#include <stdarg.h> +#include <sys/time.h> +#include <sys/types.h> +#include <sys/sysctl.h> + +#include "xo_config.h" +#include "xo.h" +#include "xo_encoder.h" /* For xo_realloc */ +#include "xo_buf.h" + +/* + * SYSLOG (RFC 5424) requires an enterprise identifier. This turns + * out to be a fickle little issue. For a single-vendor box, the + * system should have a single EID that all software can use. When + * VendorX turns FreeBSD into a product, all software (kernel and + * utilities) should report VendorX's EID. But when software is + * installed on top of an external operating system, the application + * should report it's own EID, distinct from the base OS. + * + * To make this happen, the kernel should support a sysctl to assign a + * custom enterprise-id ("kern.syslog.enterprise_id"). libxo then + * allows an application to set a custom EID to override that system + * wide value, if needed. + * + * We try to set the stock IANA assigned Enterprise ID value for the + * vendors we know about (FreeBSD, macosx), but fallback to the + * "example" EID defined by IANA. See: + * https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers + */ + +#define XO_SYSLOG_ENTERPRISE_ID "kern.syslog.enterprise_id" + +#if defined(__FreeBSD__) +#define XO_DEFAULT_EID 2238 +#elif defined(__macosx__) +#define XO_DEFAULT_EID 63 +#else +#define XO_DEFAULT_EID 32473 /* Fallback to the "example" number */ +#endif + +#ifndef HOST_NAME_MAX +#ifdef _SC_HOST_NAME_MAX +#define HOST_NAME_MAX _SC_HOST_NAME_MAX +#else +#define HOST_NAME_MAX 255 +#endif /* _SC_HOST_NAME_MAX */ +#endif /* HOST_NAME_MAX */ + +#ifndef UNUSED +#define UNUSED __attribute__ ((__unused__)) +#endif /* UNUSED */ + +static int xo_logfile = -1; /* fd for log */ +static int xo_status; /* connection xo_status */ +static int xo_opened; /* have done openlog() */ +static int xo_logstat = 0; /* xo_status bits, set by openlog() */ +static const char *xo_logtag = NULL; /* string to tag the entry with */ +static int xo_logfacility = LOG_USER; /* default facility code */ +static int xo_logmask = 0xff; /* mask of priorities to be logged */ +static pthread_mutex_t xo_syslog_mutex UNUSED = PTHREAD_MUTEX_INITIALIZER; +static int xo_unit_test; /* Fake data for unit test */ + +#define REAL_VOID(_x) \ + do { int really_ignored = _x; if (really_ignored) { }} while (0) + +#if !defined(HAVE_DECL___ISTHREADED) || !HAVE_DECL___ISTHREADED +#define __isthreaded 1 +#endif + +#define THREAD_LOCK() \ + do { \ + if (__isthreaded) pthread_mutex_lock(&xo_syslog_mutex); \ + } while(0) +#define THREAD_UNLOCK() \ + do { \ + if (__isthreaded) pthread_mutex_unlock(&xo_syslog_mutex); \ + } while(0) + +static void xo_disconnect_log(void); /* disconnect from syslogd */ +static void xo_connect_log(void); /* (re)connect to syslogd */ +static void xo_open_log_unlocked(const char *, int, int); + +enum { + NOCONN = 0, + CONNDEF, + CONNPRIV, +}; + +static xo_syslog_open_t xo_syslog_open; +static xo_syslog_send_t xo_syslog_send; +static xo_syslog_close_t xo_syslog_close; + +static char xo_syslog_enterprise_id[12]; + +/* + * Record an enterprise ID, which functions as a namespace for syslog + * messages. The value is pre-formatted into a string. This allows + * applications to customize their syslog message set, when needed. + */ +void +xo_set_syslog_enterprise_id (unsigned short eid) +{ + snprintf(xo_syslog_enterprise_id, sizeof(xo_syslog_enterprise_id), + "%u", eid); +} + +/* + * Handle the work of transmitting the syslog message + */ +static void +xo_send_syslog (char *full_msg, char *v0_hdr, + char *text_only) +{ + if (xo_syslog_send) { + xo_syslog_send(full_msg, v0_hdr, text_only); + return; + } + + int fd; + int full_len = strlen(full_msg); + + /* Output to stderr if requested, then we've been passed a v0 header */ + if (v0_hdr) { + struct iovec iov[3]; + struct iovec *v = iov; + char newline[] = "\n"; + + v->iov_base = v0_hdr; + v->iov_len = strlen(v0_hdr); + v += 1; + v->iov_base = text_only; + v->iov_len = strlen(text_only); + v += 1; + v->iov_base = newline; + v->iov_len = 1; + v += 1; + REAL_VOID(writev(STDERR_FILENO, iov, 3)); + } + + /* Get connected, output the message to the local logger. */ + if (!xo_opened) + xo_open_log_unlocked(xo_logtag, xo_logstat | LOG_NDELAY, 0); + xo_connect_log(); + + /* + * If the send() fails, there are two likely scenarios: + * 1) syslogd was restarted + * 2) /var/run/log is out of socket buffer space, which + * in most cases means local DoS. + * If the error does not indicate a full buffer, we address + * case #1 by attempting to reconnect to /var/run/log[priv] + * and resending the message once. + * + * If we are working with a privileged socket, the retry + * attempts end there, because we don't want to freeze a + * critical application like su(1) or sshd(8). + * + * Otherwise, we address case #2 by repeatedly retrying the + * send() to give syslogd a chance to empty its socket buffer. + */ + + if (send(xo_logfile, full_msg, full_len, 0) < 0) { + if (errno != ENOBUFS) { + /* + * Scenario 1: syslogd was restarted + * reconnect and resend once + */ + xo_disconnect_log(); + xo_connect_log(); + if (send(xo_logfile, full_msg, full_len, 0) >= 0) { + return; + } + /* + * if the resend failed, fall through to + * possible scenario 2 + */ + } + while (errno == ENOBUFS) { + /* + * Scenario 2: out of socket buffer space + * possible DoS, fail fast on a privileged + * socket + */ + if (xo_status == CONNPRIV) + break; + usleep(1); + if (send(xo_logfile, full_msg, full_len, 0) >= 0) { + return; + } + } + } else { + return; + } + + /* + * Output the message to the console; try not to block + * as a blocking console should not stop other processes. + * Make sure the error reported is the one from the syslogd failure. + */ + int flags = O_WRONLY | O_NONBLOCK; +#ifdef O_CLOEXEC + flags |= O_CLOEXEC; +#endif /* O_CLOEXEC */ + + if (xo_logstat & LOG_CONS + && (fd = open(_PATH_CONSOLE, flags, 0)) >= 0) { + struct iovec iov[2]; + struct iovec *v = iov; + char crnl[] = "\r\n"; + char *p; + + p = strchr(full_msg, '>') + 1; + v->iov_base = p; + v->iov_len = full_len - (p - full_msg); + ++v; + v->iov_base = crnl; + v->iov_len = 2; + REAL_VOID(writev(fd, iov, 2)); + (void) close(fd); + } +} + +/* Should be called with mutex acquired */ +static void +xo_disconnect_log (void) +{ + if (xo_syslog_close) { + xo_syslog_close(); + return; + } + + /* + * If the user closed the FD and opened another in the same slot, + * that's their problem. They should close it before calling on + * system services. + */ + if (xo_logfile != -1) { + close(xo_logfile); + xo_logfile = -1; + } + xo_status = NOCONN; /* retry connect */ +} + +/* Should be called with mutex acquired */ +static void +xo_connect_log (void) +{ + if (xo_syslog_open) { + xo_syslog_open(); + return; + } + + struct sockaddr_un saddr; /* AF_UNIX address of local logger */ + + if (xo_logfile == -1) { + int flags = SOCK_DGRAM; +#ifdef SOCK_CLOEXEC + flags |= SOCK_CLOEXEC; +#endif /* SOCK_CLOEXEC */ + if ((xo_logfile = socket(AF_UNIX, flags, 0)) == -1) + return; + } + if (xo_logfile != -1 && xo_status == NOCONN) { +#ifdef HAVE_SUN_LEN + saddr.sun_len = sizeof(saddr); +#endif /* HAVE_SUN_LEN */ + saddr.sun_family = AF_UNIX; + + /* + * First try privileged socket. If no success, + * then try default socket. + */ + +#ifdef _PATH_LOG_PRIV + (void) strncpy(saddr.sun_path, _PATH_LOG_PRIV, + sizeof saddr.sun_path); + if (connect(xo_logfile, (struct sockaddr *) &saddr, + sizeof(saddr)) != -1) + xo_status = CONNPRIV; +#endif /* _PATH_LOG_PRIV */ + +#ifdef _PATH_LOG + if (xo_status == NOCONN) { + (void) strncpy(saddr.sun_path, _PATH_LOG, + sizeof saddr.sun_path); + if (connect(xo_logfile, (struct sockaddr *)&saddr, + sizeof(saddr)) != -1) + xo_status = CONNDEF; + } +#endif /* _PATH_LOG */ + +#ifdef _PATH_OLDLOG + if (xo_status == NOCONN) { + /* + * Try the old "/dev/log" path, for backward + * compatibility. + */ + (void) strncpy(saddr.sun_path, _PATH_OLDLOG, + sizeof saddr.sun_path); + if (connect(xo_logfile, (struct sockaddr *)&saddr, + sizeof(saddr)) != -1) + xo_status = CONNDEF; + } +#endif /* _PATH_OLDLOG */ + + if (xo_status == NOCONN) { + (void) close(xo_logfile); + xo_logfile = -1; + } + } +} + +static void +xo_open_log_unlocked (const char *ident, int logstat, int logfac) +{ + if (ident != NULL) + xo_logtag = ident; + xo_logstat = logstat; + if (logfac != 0 && (logfac &~ LOG_FACMASK) == 0) + xo_logfacility = logfac; + + if (xo_logstat & LOG_NDELAY) /* open immediately */ + xo_connect_log(); + + xo_opened = 1; /* ident and facility has been set */ +} + +void +xo_open_log (const char *ident, int logstat, int logfac) +{ + THREAD_LOCK(); + xo_open_log_unlocked(ident, logstat, logfac); + THREAD_UNLOCK(); +} + + +void +xo_close_log (void) +{ + THREAD_LOCK(); + if (xo_logfile != -1) { + (void) close(xo_logfile); + xo_logfile = -1; + } + xo_logtag = NULL; + xo_status = NOCONN; + THREAD_UNLOCK(); +} + +/* xo_set_logmask -- set the log mask level */ +int +xo_set_logmask (int pmask) +{ + int omask; + + THREAD_LOCK(); + omask = xo_logmask; + if (pmask != 0) + xo_logmask = pmask; + THREAD_UNLOCK(); + return (omask); +} + +void +xo_set_syslog_handler (xo_syslog_open_t open_func, + xo_syslog_send_t send_func, + xo_syslog_close_t close_func) +{ + xo_syslog_open = open_func; + xo_syslog_send = send_func; + xo_syslog_close = close_func; +} + +static ssize_t +xo_snprintf (char *out, ssize_t outsize, const char *fmt, ...) +{ + ssize_t status; + ssize_t retval = 0; + va_list ap; + + if (out && outsize) { + va_start(ap, fmt); + status = vsnprintf(out, outsize, fmt, ap); + if (status < 0) { /* this should never happen, */ + *out = 0; /* handle it in the safest way possible if it does */ + retval = 0; + } else { + retval = status; + retval = retval > outsize ? outsize : retval; + } + va_end(ap); + } + + return retval; +} + +static xo_ssize_t +xo_syslog_handle_write (void *opaque, const char *data) +{ + xo_buffer_t *xbp = opaque; + int len = strlen(data); + int left = xo_buf_left(xbp); + + if (len > left - 1) + len = left - 1; + + memcpy(xbp->xb_curp, data, len); + xbp->xb_curp += len; + *xbp->xb_curp = '\0'; + + return len; +} + +static void +xo_syslog_handle_close (void *opaque UNUSED) +{ +} + +static int +xo_syslog_handle_flush (void *opaque UNUSED) +{ + return 0; +} + +void +xo_set_unit_test_mode (int value) +{ + xo_unit_test = value; +} + +void +xo_vsyslog (int pri, const char *name, const char *fmt, va_list vap) +{ + int saved_errno = errno; + char tbuf[2048]; + char *tp = NULL, *ep = NULL; + unsigned start_of_msg = 0; + char *v0_hdr = NULL; + xo_buffer_t xb; + static pid_t my_pid; + unsigned log_offset; + + if (my_pid == 0) + my_pid = xo_unit_test ? 222 : getpid(); + + /* Check for invalid bits */ + if (pri & ~(LOG_PRIMASK|LOG_FACMASK)) { + xo_syslog(LOG_ERR | LOG_CONS | LOG_PERROR | LOG_PID, + "syslog-unknown-priority", + "syslog: unknown facility/priority: %#x", pri); + pri &= LOG_PRIMASK|LOG_FACMASK; + } + + THREAD_LOCK(); + + /* Check priority against setlogmask values. */ + if (!(LOG_MASK(LOG_PRI(pri)) & xo_logmask)) { + THREAD_UNLOCK(); + return; + } + + /* Set default facility if none specified. */ + if ((pri & LOG_FACMASK) == 0) + pri |= xo_logfacility; + + /* Create the primary stdio hook */ + xb.xb_bufp = tbuf; + xb.xb_curp = tbuf; + xb.xb_size = sizeof(tbuf); + + xo_handle_t *xop = xo_create(XO_STYLE_SDPARAMS, 0); + if (xop == NULL) { + THREAD_UNLOCK(); + return; + } + +#ifdef HAVE_GETPROGNAME + if (xo_logtag == NULL) + xo_logtag = getprogname(); +#endif /* HAVE_GETPROGNAME */ + + xo_set_writer(xop, &xb, xo_syslog_handle_write, xo_syslog_handle_close, + xo_syslog_handle_flush); + + /* Build the message; start by getting the time */ + struct tm tm; + struct timeval tv; + + /* Unit test hack: fake a fixed time */ + if (xo_unit_test) { + tv.tv_sec = 1435085229; + tv.tv_usec = 123456; + } else + gettimeofday(&tv, NULL); + + (void) localtime_r(&tv.tv_sec, &tm); + + if (xo_logstat & LOG_PERROR) { + /* + * For backwards compatibility, we need to make the old-style + * message. This message can be emitted to the console/tty. + */ + v0_hdr = alloca(2048); + tp = v0_hdr; + ep = v0_hdr + 2048; + + if (xo_logtag != NULL) + tp += xo_snprintf(tp, ep - tp, "%s", xo_logtag); + if (xo_logstat & LOG_PID) + tp += xo_snprintf(tp, ep - tp, "[%d]", my_pid); + if (xo_logtag) + tp += xo_snprintf(tp, ep - tp, ": "); + } + + log_offset = xb.xb_curp - xb.xb_bufp; + + /* Add PRI, PRIVAL, and VERSION */ + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), "<%d>1 ", pri); + + /* Add TIMESTAMP with milliseconds and TZOFFSET */ + xb.xb_curp += strftime(xb.xb_curp, xo_buf_left(&xb), "%FT%T", &tm); + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), + ".%03.3u", tv.tv_usec / 1000); + xb.xb_curp += strftime(xb.xb_curp, xo_buf_left(&xb), "%z ", &tm); + + /* + * Add HOSTNAME; we rely on gethostname and don't fluff with + * ip addresses. Might need to revisit..... + */ + char hostname[HOST_NAME_MAX]; + hostname[0] = '\0'; + if (xo_unit_test) + strcpy(hostname, "worker-host"); + else + (void) gethostname(hostname, sizeof(hostname)); + + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), "%s ", + hostname[0] ? hostname : "-"); + + /* Add APP-NAME */ + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), "%s ", + xo_logtag ?: "-"); + + /* Add PROCID */ + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), "%d ", my_pid); + + /* + * Add MSGID. The user should provide us with a name, which we + * prefix with the current enterprise ID, as learned from the kernel. + * If the kernel won't tell us, we use the stock/builtin number. + */ + char *buf UNUSED = NULL; + const char *eid = xo_syslog_enterprise_id; + const char *at_sign = "@"; + + if (name == NULL) { + name = "-"; + eid = at_sign = ""; + + } else if (*name == '@') { + /* Our convention is to prefix IANA-defined names with an "@" */ + name += 1; + eid = at_sign = ""; + + } else if (eid[0] == '\0') { +#ifdef HAVE_SYSCTLBYNAME + /* + * See if the kernel knows the sysctl for the enterprise ID + */ + size_t size = 0; + if (sysctlbyname(XO_SYSLOG_ENTERPRISE_ID, NULL, &size, NULL, 0) == 0 + && size > 0) { + buf = alloca(size); + if (sysctlbyname(XO_SYSLOG_ENTERPRISE_ID, buf, &size, NULL, 0) == 0 + && size > 0) + eid = buf; + } +#endif /* HAVE_SYSCTLBYNAME */ + + if (eid[0] == '\0') { + /* Fallback to our base default */ + xo_set_syslog_enterprise_id(XO_DEFAULT_EID); + eid = xo_syslog_enterprise_id; + } + } + + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), "%s [%s%s%s ", + name, name, at_sign, eid); + + /* + * Now for the real content. We make two distinct passes thru the + * xo_emit engine, first for the SD-PARAMS and then for the text + * message. + */ + va_list ap; + va_copy(ap, vap); + + errno = saved_errno; /* Restore saved error value */ + xo_emit_hv(xop, fmt, ap); + xo_flush_h(xop); + + va_end(ap); + + /* Trim trailing space */ + if (xb.xb_curp[-1] == ' ') + xb.xb_curp -= 1; + + /* Close the structured data (SD-ELEMENT) */ + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), "] "); + + /* + * Since our MSG is known to be UTF-8, we MUST prefix it with + * that most-annoying-of-all-UTF-8 features, the BOM (0xEF.BB.BF). + */ + xb.xb_curp += xo_snprintf(xb.xb_curp, xo_buf_left(&xb), + "%c%c%c", 0xEF, 0xBB, 0xBF); + + /* Save the start of the message */ + if (xo_logstat & LOG_PERROR) + start_of_msg = xb.xb_curp - xb.xb_bufp; + + xo_set_style(xop, XO_STYLE_TEXT); + xo_set_flags(xop, XOF_UTF8); + + errno = saved_errno; /* Restore saved error value */ + xo_emit_hv(xop, fmt, ap); + xo_flush_h(xop); + + /* Remove a trailing newline */ + if (xb.xb_curp[-1] == '\n') + *--xb.xb_curp = '\0'; + + if (xo_get_flags(xop) & XOF_LOG_SYSLOG) + fprintf(stderr, "xo: syslog: %s\n", xb.xb_bufp + log_offset); + + xo_send_syslog(xb.xb_bufp, v0_hdr, xb.xb_bufp + start_of_msg); + + xo_destroy(xop); + + THREAD_UNLOCK(); +} + +/* + * syslog - print message on log file; output is intended for syslogd(8). + */ +void +xo_syslog (int pri, const char *name, const char *fmt, ...) +{ + va_list ap; + + va_start(ap, fmt); + xo_vsyslog(pri, name, fmt, ap); + va_end(ap); +} diff --git a/contrib/libxo/libxo/xo_wcwidth.h b/contrib/libxo/libxo/xo_wcwidth.h new file mode 100644 index 000000000000..46d83f0365d2 --- /dev/null +++ b/contrib/libxo/libxo/xo_wcwidth.h @@ -0,0 +1,313 @@ +/* + * This is an implementation of wcwidth() and wcswidth() (defined in + * IEEE Std 1002.1-2001) for Unicode. + * + * http://www.opengroup.org/onlinepubs/007904975/functions/wcwidth.html + * http://www.opengroup.org/onlinepubs/007904975/functions/wcswidth.html + * + * In fixed-width output devices, Latin characters all occupy a single + * "cell" position of equal width, whereas ideographic CJK characters + * occupy two such cells. Interoperability between terminal-line + * applications and (teletype-style) character terminals using the + * UTF-8 encoding requires agreement on which character should advance + * the cursor by how many cell positions. No established formal + * standards exist at present on which Unicode character shall occupy + * how many cell positions on character terminals. These routines are + * a first attempt of defining such behavior based on simple rules + * applied to data provided by the Unicode Consortium. + * + * For some graphical characters, the Unicode standard explicitly + * defines a character-cell width via the definition of the East Asian + * FullWidth (F), Wide (W), Half-width (H), and Narrow (Na) classes. + * In all these cases, there is no ambiguity about which width a + * terminal shall use. For characters in the East Asian Ambiguous (A) + * class, the width choice depends purely on a preference of backward + * compatibility with either historic CJK or Western practice. + * Choosing single-width for these characters is easy to justify as + * the appropriate long-term solution, as the CJK practice of + * displaying these characters as double-width comes from historic + * implementation simplicity (8-bit encoded characters were displayed + * single-width and 16-bit ones double-width, even for Greek, + * Cyrillic, etc.) and not any typographic considerations. + * + * Much less clear is the choice of width for the Not East Asian + * (Neutral) class. Existing practice does not dictate a width for any + * of these characters. It would nevertheless make sense + * typographically to allocate two character cells to characters such + * as for instance EM SPACE or VOLUME INTEGRAL, which cannot be + * represented adequately with a single-width glyph. The following + * routines at present merely assign a single-cell width to all + * neutral characters, in the interest of simplicity. This is not + * entirely satisfactory and should be reconsidered before + * establishing a formal standard in this area. At the moment, the + * decision which Not East Asian (Neutral) characters should be + * represented by double-width glyphs cannot yet be answered by + * applying a simple rule from the Unicode database content. Setting + * up a proper standard for the behavior of UTF-8 character terminals + * will require a careful analysis not only of each Unicode character, + * but also of each presentation form, something the author of these + * routines has avoided to do so far. + * + * http://www.unicode.org/unicode/reports/tr11/ + * + * Markus Kuhn -- 2007-05-26 (Unicode 5.0) + * + * Permission to use, copy, modify, and distribute this software + * for any purpose and without fee is hereby granted. The author + * disclaims all warranties with regard to this software. + * + * Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c + */ + +#include <wchar.h> + +struct interval { + wchar_t first; + wchar_t last; +}; + +/* auxiliary function for binary search in interval table */ +static int +xo_bisearch (wchar_t ucs, const struct interval *table, int max) +{ + int min = 0; + int mid; + + if (ucs < table[0].first || ucs > table[max].last) + return 0; + while (max >= min) { + mid = (min + max) / 2; + if (ucs > table[mid].last) + min = mid + 1; + else if (ucs < table[mid].first) + max = mid - 1; + else + return 1; + } + + return 0; +} + + +/* The following two functions define the column width of an ISO 10646 + * character as follows: + * + * - The null character (U+0000) has a column width of 0. + * + * - Other C0/C1 control characters and DEL will lead to a return + * value of -1. + * + * - Non-spacing and enclosing combining characters (general + * category code Mn or Me in the Unicode database) have a + * column width of 0. + * + * - SOFT HYPHEN (U+00AD) has a column width of 1. + * + * - Other format characters (general category code Cf in the Unicode + * database) and ZERO WIDTH SPACE (U+200B) have a column width of 0. + * + * - Hangul Jamo medial vowels and final consonants (U+1160-U+11FF) + * have a column width of 0. + * + * - Spacing characters in the East Asian Wide (W) or East Asian + * Full-width (F) category as defined in Unicode Technical + * Report #11 have a column width of 2. + * + * - All remaining characters (including all printable + * ISO 8859-1 and WGL4 characters, Unicode control characters, + * etc.) have a column width of 1. + * + * This implementation assumes that wchar_t characters are encoded + * in ISO 10646. + */ + +static int +xo_wcwidth (wchar_t ucs) +{ + /* sorted list of non-overlapping intervals of non-spacing characters */ + /* generated by "uniset +cat=Me +cat=Mn +cat=Cf -00AD +1160-11FF +200B c" */ + static const struct interval combining[] = { + { 0x0300, 0x036F }, { 0x0483, 0x0486 }, { 0x0488, 0x0489 }, + { 0x0591, 0x05BD }, { 0x05BF, 0x05BF }, { 0x05C1, 0x05C2 }, + { 0x05C4, 0x05C5 }, { 0x05C7, 0x05C7 }, { 0x0600, 0x0603 }, + { 0x0610, 0x0615 }, { 0x064B, 0x065E }, { 0x0670, 0x0670 }, + { 0x06D6, 0x06E4 }, { 0x06E7, 0x06E8 }, { 0x06EA, 0x06ED }, + { 0x070F, 0x070F }, { 0x0711, 0x0711 }, { 0x0730, 0x074A }, + { 0x07A6, 0x07B0 }, { 0x07EB, 0x07F3 }, { 0x0901, 0x0902 }, + { 0x093C, 0x093C }, { 0x0941, 0x0948 }, { 0x094D, 0x094D }, + { 0x0951, 0x0954 }, { 0x0962, 0x0963 }, { 0x0981, 0x0981 }, + { 0x09BC, 0x09BC }, { 0x09C1, 0x09C4 }, { 0x09CD, 0x09CD }, + { 0x09E2, 0x09E3 }, { 0x0A01, 0x0A02 }, { 0x0A3C, 0x0A3C }, + { 0x0A41, 0x0A42 }, { 0x0A47, 0x0A48 }, { 0x0A4B, 0x0A4D }, + { 0x0A70, 0x0A71 }, { 0x0A81, 0x0A82 }, { 0x0ABC, 0x0ABC }, + { 0x0AC1, 0x0AC5 }, { 0x0AC7, 0x0AC8 }, { 0x0ACD, 0x0ACD }, + { 0x0AE2, 0x0AE3 }, { 0x0B01, 0x0B01 }, { 0x0B3C, 0x0B3C }, + { 0x0B3F, 0x0B3F }, { 0x0B41, 0x0B43 }, { 0x0B4D, 0x0B4D }, + { 0x0B56, 0x0B56 }, { 0x0B82, 0x0B82 }, { 0x0BC0, 0x0BC0 }, + { 0x0BCD, 0x0BCD }, { 0x0C3E, 0x0C40 }, { 0x0C46, 0x0C48 }, + { 0x0C4A, 0x0C4D }, { 0x0C55, 0x0C56 }, { 0x0CBC, 0x0CBC }, + { 0x0CBF, 0x0CBF }, { 0x0CC6, 0x0CC6 }, { 0x0CCC, 0x0CCD }, + { 0x0CE2, 0x0CE3 }, { 0x0D41, 0x0D43 }, { 0x0D4D, 0x0D4D }, + { 0x0DCA, 0x0DCA }, { 0x0DD2, 0x0DD4 }, { 0x0DD6, 0x0DD6 }, + { 0x0E31, 0x0E31 }, { 0x0E34, 0x0E3A }, { 0x0E47, 0x0E4E }, + { 0x0EB1, 0x0EB1 }, { 0x0EB4, 0x0EB9 }, { 0x0EBB, 0x0EBC }, + { 0x0EC8, 0x0ECD }, { 0x0F18, 0x0F19 }, { 0x0F35, 0x0F35 }, + { 0x0F37, 0x0F37 }, { 0x0F39, 0x0F39 }, { 0x0F71, 0x0F7E }, + { 0x0F80, 0x0F84 }, { 0x0F86, 0x0F87 }, { 0x0F90, 0x0F97 }, + { 0x0F99, 0x0FBC }, { 0x0FC6, 0x0FC6 }, { 0x102D, 0x1030 }, + { 0x1032, 0x1032 }, { 0x1036, 0x1037 }, { 0x1039, 0x1039 }, + { 0x1058, 0x1059 }, { 0x1160, 0x11FF }, { 0x135F, 0x135F }, + { 0x1712, 0x1714 }, { 0x1732, 0x1734 }, { 0x1752, 0x1753 }, + { 0x1772, 0x1773 }, { 0x17B4, 0x17B5 }, { 0x17B7, 0x17BD }, + { 0x17C6, 0x17C6 }, { 0x17C9, 0x17D3 }, { 0x17DD, 0x17DD }, + { 0x180B, 0x180D }, { 0x18A9, 0x18A9 }, { 0x1920, 0x1922 }, + { 0x1927, 0x1928 }, { 0x1932, 0x1932 }, { 0x1939, 0x193B }, + { 0x1A17, 0x1A18 }, { 0x1B00, 0x1B03 }, { 0x1B34, 0x1B34 }, + { 0x1B36, 0x1B3A }, { 0x1B3C, 0x1B3C }, { 0x1B42, 0x1B42 }, + { 0x1B6B, 0x1B73 }, { 0x1DC0, 0x1DCA }, { 0x1DFE, 0x1DFF }, + { 0x200B, 0x200F }, { 0x202A, 0x202E }, { 0x2060, 0x2063 }, + { 0x206A, 0x206F }, { 0x20D0, 0x20EF }, { 0x302A, 0x302F }, + { 0x3099, 0x309A }, { 0xA806, 0xA806 }, { 0xA80B, 0xA80B }, + { 0xA825, 0xA826 }, { 0xFB1E, 0xFB1E }, { 0xFE00, 0xFE0F }, + { 0xFE20, 0xFE23 }, { 0xFEFF, 0xFEFF }, { 0xFFF9, 0xFFFB }, + { 0x10A01, 0x10A03 }, { 0x10A05, 0x10A06 }, { 0x10A0C, 0x10A0F }, + { 0x10A38, 0x10A3A }, { 0x10A3F, 0x10A3F }, { 0x1D167, 0x1D169 }, + { 0x1D173, 0x1D182 }, { 0x1D185, 0x1D18B }, { 0x1D1AA, 0x1D1AD }, + { 0x1D242, 0x1D244 }, { 0xE0001, 0xE0001 }, { 0xE0020, 0xE007F }, + { 0xE0100, 0xE01EF } + }; + + /* test for 8-bit control characters */ + if (ucs == 0) + return 0; + if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0)) + return -1; + + /* binary search in table of non-spacing characters */ + if (xo_bisearch(ucs, combining, + sizeof(combining) / sizeof(struct interval) - 1)) + return 0; + + /* if we arrive here, ucs is not a combining or C0/C1 control character */ + + return 1 + + (ucs >= 0x1100 && + (ucs <= 0x115f || /* Hangul Jamo init. consonants */ + ucs == 0x2329 || ucs == 0x232a || + (ucs >= 0x2e80 && ucs <= 0xa4cf && + ucs != 0x303f) || /* CJK ... Yi */ + (ucs >= 0xac00 && ucs <= 0xd7a3) || /* Hangul Syllables */ + (ucs >= 0xf900 && ucs <= 0xfaff) || /* CJK Compatibility Ideographs */ + (ucs >= 0xfe10 && ucs <= 0xfe19) || /* Vertical forms */ + (ucs >= 0xfe30 && ucs <= 0xfe6f) || /* CJK Compatibility Forms */ + (ucs >= 0xff00 && ucs <= 0xff60) || /* Fullwidth Forms */ + (ucs >= 0xffe0 && ucs <= 0xffe6) || + (ucs >= 0x20000 && ucs <= 0x2fffd) || + (ucs >= 0x30000 && ucs <= 0x3fffd))); +} + +#if UNUSED_CODE +static int xo_wcswidth(const wchar_t *pwcs, size_t n) +{ + int w, width = 0; + + for (;*pwcs && n-- > 0; pwcs++) + if ((w = mk_wcwidth(*pwcs)) < 0) + return -1; + else + width += w; + + return width; +} + + +/* + * The following functions are the same as mk_wcwidth() and + * mk_wcswidth(), except that spacing characters in the East Asian + * Ambiguous (A) category as defined in Unicode Technical Report #11 + * have a column width of 2. This variant might be useful for users of + * CJK legacy encodings who want to migrate to UCS without changing + * the traditional terminal character-width behaviour. It is not + * otherwise recommended for general use. + */ +int mk_wcwidth_cjk(wchar_t ucs) +{ + /* sorted list of non-overlapping intervals of East Asian Ambiguous + * characters, generated by "uniset +WIDTH-A -cat=Me -cat=Mn -cat=Cf c" */ + static const struct interval ambiguous[] = { + { 0x00A1, 0x00A1 }, { 0x00A4, 0x00A4 }, { 0x00A7, 0x00A8 }, + { 0x00AA, 0x00AA }, { 0x00AE, 0x00AE }, { 0x00B0, 0x00B4 }, + { 0x00B6, 0x00BA }, { 0x00BC, 0x00BF }, { 0x00C6, 0x00C6 }, + { 0x00D0, 0x00D0 }, { 0x00D7, 0x00D8 }, { 0x00DE, 0x00E1 }, + { 0x00E6, 0x00E6 }, { 0x00E8, 0x00EA }, { 0x00EC, 0x00ED }, + { 0x00F0, 0x00F0 }, { 0x00F2, 0x00F3 }, { 0x00F7, 0x00FA }, + { 0x00FC, 0x00FC }, { 0x00FE, 0x00FE }, { 0x0101, 0x0101 }, + { 0x0111, 0x0111 }, { 0x0113, 0x0113 }, { 0x011B, 0x011B }, + { 0x0126, 0x0127 }, { 0x012B, 0x012B }, { 0x0131, 0x0133 }, + { 0x0138, 0x0138 }, { 0x013F, 0x0142 }, { 0x0144, 0x0144 }, + { 0x0148, 0x014B }, { 0x014D, 0x014D }, { 0x0152, 0x0153 }, + { 0x0166, 0x0167 }, { 0x016B, 0x016B }, { 0x01CE, 0x01CE }, + { 0x01D0, 0x01D0 }, { 0x01D2, 0x01D2 }, { 0x01D4, 0x01D4 }, + { 0x01D6, 0x01D6 }, { 0x01D8, 0x01D8 }, { 0x01DA, 0x01DA }, + { 0x01DC, 0x01DC }, { 0x0251, 0x0251 }, { 0x0261, 0x0261 }, + { 0x02C4, 0x02C4 }, { 0x02C7, 0x02C7 }, { 0x02C9, 0x02CB }, + { 0x02CD, 0x02CD }, { 0x02D0, 0x02D0 }, { 0x02D8, 0x02DB }, + { 0x02DD, 0x02DD }, { 0x02DF, 0x02DF }, { 0x0391, 0x03A1 }, + { 0x03A3, 0x03A9 }, { 0x03B1, 0x03C1 }, { 0x03C3, 0x03C9 }, + { 0x0401, 0x0401 }, { 0x0410, 0x044F }, { 0x0451, 0x0451 }, + { 0x2010, 0x2010 }, { 0x2013, 0x2016 }, { 0x2018, 0x2019 }, + { 0x201C, 0x201D }, { 0x2020, 0x2022 }, { 0x2024, 0x2027 }, + { 0x2030, 0x2030 }, { 0x2032, 0x2033 }, { 0x2035, 0x2035 }, + { 0x203B, 0x203B }, { 0x203E, 0x203E }, { 0x2074, 0x2074 }, + { 0x207F, 0x207F }, { 0x2081, 0x2084 }, { 0x20AC, 0x20AC }, + { 0x2103, 0x2103 }, { 0x2105, 0x2105 }, { 0x2109, 0x2109 }, + { 0x2113, 0x2113 }, { 0x2116, 0x2116 }, { 0x2121, 0x2122 }, + { 0x2126, 0x2126 }, { 0x212B, 0x212B }, { 0x2153, 0x2154 }, + { 0x215B, 0x215E }, { 0x2160, 0x216B }, { 0x2170, 0x2179 }, + { 0x2190, 0x2199 }, { 0x21B8, 0x21B9 }, { 0x21D2, 0x21D2 }, + { 0x21D4, 0x21D4 }, { 0x21E7, 0x21E7 }, { 0x2200, 0x2200 }, + { 0x2202, 0x2203 }, { 0x2207, 0x2208 }, { 0x220B, 0x220B }, + { 0x220F, 0x220F }, { 0x2211, 0x2211 }, { 0x2215, 0x2215 }, + { 0x221A, 0x221A }, { 0x221D, 0x2220 }, { 0x2223, 0x2223 }, + { 0x2225, 0x2225 }, { 0x2227, 0x222C }, { 0x222E, 0x222E }, + { 0x2234, 0x2237 }, { 0x223C, 0x223D }, { 0x2248, 0x2248 }, + { 0x224C, 0x224C }, { 0x2252, 0x2252 }, { 0x2260, 0x2261 }, + { 0x2264, 0x2267 }, { 0x226A, 0x226B }, { 0x226E, 0x226F }, + { 0x2282, 0x2283 }, { 0x2286, 0x2287 }, { 0x2295, 0x2295 }, + { 0x2299, 0x2299 }, { 0x22A5, 0x22A5 }, { 0x22BF, 0x22BF }, + { 0x2312, 0x2312 }, { 0x2460, 0x24E9 }, { 0x24EB, 0x254B }, + { 0x2550, 0x2573 }, { 0x2580, 0x258F }, { 0x2592, 0x2595 }, + { 0x25A0, 0x25A1 }, { 0x25A3, 0x25A9 }, { 0x25B2, 0x25B3 }, + { 0x25B6, 0x25B7 }, { 0x25BC, 0x25BD }, { 0x25C0, 0x25C1 }, + { 0x25C6, 0x25C8 }, { 0x25CB, 0x25CB }, { 0x25CE, 0x25D1 }, + { 0x25E2, 0x25E5 }, { 0x25EF, 0x25EF }, { 0x2605, 0x2606 }, + { 0x2609, 0x2609 }, { 0x260E, 0x260F }, { 0x2614, 0x2615 }, + { 0x261C, 0x261C }, { 0x261E, 0x261E }, { 0x2640, 0x2640 }, + { 0x2642, 0x2642 }, { 0x2660, 0x2661 }, { 0x2663, 0x2665 }, + { 0x2667, 0x266A }, { 0x266C, 0x266D }, { 0x266F, 0x266F }, + { 0x273D, 0x273D }, { 0x2776, 0x277F }, { 0xE000, 0xF8FF }, + { 0xFFFD, 0xFFFD }, { 0xF0000, 0xFFFFD }, { 0x100000, 0x10FFFD } + }; + + /* binary search in table of non-spacing characters */ + if (xo_bisearch(ucs, ambiguous, + sizeof(ambiguous) / sizeof(struct interval) - 1)) + return 2; + + return mk_wcwidth(ucs); +} + + +int mk_wcswidth_cjk(const wchar_t *pwcs, size_t n) +{ + int w, width = 0; + + for (;*pwcs && n-- > 0; pwcs++) + if ((w = mk_wcwidth_cjk(*pwcs)) < 0) + return -1; + else + width += w; + + return width; +} +#endif /* UNUSED_CODE */ diff --git a/contrib/libxo/packaging/libxo.pc.in b/contrib/libxo/packaging/libxo.pc.in new file mode 100644 index 000000000000..0e18234f1020 --- /dev/null +++ b/contrib/libxo/packaging/libxo.pc.in @@ -0,0 +1,11 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + + +Name: libxo +Version: @LIBXO_VERSION@ +Description: The XML Output Library +Libs: -L@XO_LIBDIR@ @XO_LIBS@ +Cflags: -I@XO_INCLUDEDIR@ diff --git a/contrib/libxo/packaging/libxo.rb.base.in b/contrib/libxo/packaging/libxo.rb.base.in new file mode 100644 index 000000000000..ab87be296c6c --- /dev/null +++ b/contrib/libxo/packaging/libxo.rb.base.in @@ -0,0 +1,20 @@ +# +# Homebrew formula file for libxo +# https://github.com/mxcl/homebrew +# + +require 'formula' + +class Libxo < Formula + homepage 'https://github.com/Juniper/@PACKAGE_NAME@' + url 'https://github.com/Juniper/@PACKAGE_NAME@/releases/download/@PACKAGE_VERSION@/@PACKAGE_NAME@-@PACKAGE_VERSION@.tar.gz' + sha1 '__SHA1__' + + depends_on 'libtool' => :build + + def install + system "./configure", "--disable-dependency-tracking", "--disable-silent-rules", + "--prefix=#{prefix}" + system "make", "install" + end +end diff --git a/contrib/libxo/packaging/libxo.spec.in b/contrib/libxo/packaging/libxo.spec.in new file mode 100644 index 000000000000..e80634cb508e --- /dev/null +++ b/contrib/libxo/packaging/libxo.spec.in @@ -0,0 +1,44 @@ +Name: @PACKAGE_NAME@ +Version: @PACKAGE_VERSION@ +Release: 1%{?dist} +Summary: The libxo library + +Prefix: /usr + +Vendor: Juniper Networks, Inc. +Packager: Phil Shafer <phil@juniper.net> +License: BSD + +Group: Development/Libraries +URL: https://github.com/Juniper/libxo +Source0: https://github.com/Juniper/@PACKAGE_NAME@/releases/@PACKAGE_VERSION@/@PACKAGE_NAME@-@PACKAGE_VERSION@.tar.gz + + +%description +Welcome to libxo, a library that generates text, XML, JSON, and HTML +from a single source code path. + +%prep +%setup -q + +%build +%configure +make %{?_smp_mflags} + +%install +rm -rf $RPM_BUILD_ROOT +%make_install + +%clean +rm -rf $RPM_BUILD_ROOT + +%post -p /sbin/ldconfig + +%files +%{_bindir}/* +%{_includedir}/libxo/* +%{_libdir}/* +%{_datadir}/doc/libxo/* +%docdir %{_datadir}/doc/libxo/* +%{_mandir}/*/* +%docdir %{_mandir}/*/* diff --git a/contrib/libxo/tests/Makefile.am b/contrib/libxo/tests/Makefile.am new file mode 100644 index 000000000000..b6d3e7199fc8 --- /dev/null +++ b/contrib/libxo/tests/Makefile.am @@ -0,0 +1,32 @@ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +SUBDIRS = core xo + +if HAVE_GETTEXT +SUBDIRS += gettext +endif + +test tests: + @(cur=`pwd` ; for dir in $(SUBDIRS) ; do \ + cd $$dir ; \ + $(MAKE) tests ; \ + cd $$cur ; \ + done) + +accept: + @(cur=`pwd` ; for dir in $(SUBDIRS) ; do \ + cd $$dir ; \ + $(MAKE) accept ; \ + cd $$cur ; \ + done) + +valgrind: + @echo '## Running the regression tests under Valgrind' + @echo '## Go get a cup of coffee it is gonna take a while ...' + ${MAKE} VALGRIND='valgrind -q' tests diff --git a/contrib/libxo/tests/core/Makefile.am b/contrib/libxo/tests/core/Makefile.am new file mode 100644 index 000000000000..1e7010711757 --- /dev/null +++ b/contrib/libxo/tests/core/Makefile.am @@ -0,0 +1,156 @@ +# +# $Id$ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +AM_CFLAGS = -I${top_srcdir} -I${top_srcdir}/libxo + +# Ick: maintained by hand! +TEST_CASES = \ +test_01.c \ +test_02.c \ +test_03.c \ +test_04.c \ +test_05.c \ +test_06.c \ +test_07.c \ +test_08.c \ +test_09.c \ +test_10.c \ +test_11.c \ +test_12.c + +test_01_test_SOURCES = test_01.c +test_02_test_SOURCES = test_02.c +test_03_test_SOURCES = test_03.c +test_04_test_SOURCES = test_04.c +test_05_test_SOURCES = test_05.c +test_06_test_SOURCES = test_06.c +test_07_test_SOURCES = test_07.c +test_08_test_SOURCES = test_08.c +test_09_test_SOURCES = test_09.c +test_10_test_SOURCES = test_10.c +test_11_test_SOURCES = test_11.c +test_12_test_SOURCES = test_12.c + +# TEST_CASES := $(shell cd ${srcdir} ; echo *.c ) + +noinst_PROGRAMS = ${TEST_CASES:.c=.test} + +LDADD = \ + ${top_builddir}/libxo/libxo.la + +if HAVE_HUMANIZE_NUMBER +LDADD += -lutil +endif + +EXTRA_DIST = \ + ${TEST_CASES} \ + ${addprefix saved/, ${TEST_CASES:.c=.E.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.E.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.H.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.H.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HIPx.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HIPx.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HP.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HP.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.J.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.J.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.JP.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.JP.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.JPu.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.JPu.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.T.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.T.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.X.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.X.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.XP.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.XP.out}} \ + ${addprefix saved/, test_01.Ecsv1.out} \ + ${addprefix saved/, test_01.Ecsv1.err} \ + ${addprefix saved/, test_01.Ecsv2.out} \ + ${addprefix saved/, test_01.Ecsv2.err} \ + ${addprefix saved/, test_01.Ecsv3.out} \ + ${addprefix saved/, test_01.Ecsv3.err} + +S2O = | ${SED} '1,/@@/d' + +all: + +valgrind: + @echo '## Running the regression tests under Valgrind' + ${MAKE} CHECKER='valgrind -q' tests + +#TEST_TRACE = set -x ; + +TEST_JIG = \ + ${CHECKER} ./$$base.test --libxo$$xoopts ${TEST_OPTS} \ + > out/$$base.$$fmt.out 2> out/$$base.$$fmt.err ; \ + ${DIFF} -Nu ${srcdir}/saved/$$base.$$fmt.out out/$$base.$$fmt.out ${S2O} ; \ + ${DIFF} -Nu ${srcdir}/saved/$$base.$$fmt.err out/$$base.$$fmt.err ${S2O} + +TEST_JIG2 = \ +echo "... $$test ... $$fmt ..."; \ +xoopts==warn,$$csv ; \ +${TEST_JIG}; true; + +TEST_FORMATS = T XP JP JPu HP X J H HIPx + +test tests: ${bin_PROGRAMS} + @${MKDIR} -p out + -@ ${TEST_TRACE} (for test in ${TEST_CASES} ; do \ + base=`${BASENAME} $$test .c` ; \ + (for fmt in ${TEST_FORMATS}; do \ + echo "... $$test ... $$fmt ..."; \ + xoopts=:W$$fmt ; \ + ${TEST_JIG}; \ + true; \ + done) ; \ + (for fmt in E; do \ + echo "... $$test ... $$fmt ..."; \ + xoopts==warn,encoder=test ; \ + ${TEST_JIG}; \ + true; \ + done) \ + done) + -@ (${TEST_TRACE} test=test_01.c; base=test_01; \ + ( fmt=Ecsv1; csv=encoder=csv ; \ + ${TEST_JIG2} ); \ + ( fmt=Ecsv2; csv=encoder=csv:path=top-level/data/item:no-header ; \ + ${TEST_JIG2} ); \ + ( fmt=Ecsv3; csv=@csv:path=item:leafs=sku.sold:no-quotes ; \ + ${TEST_JIG2} ); \ + ) + + +one: + -@(test=${TEST_CASE}; data=${TEST_DATA}; ${TEST_ONE} ; true) + +accept: + -@(for test in ${TEST_CASES} ; do \ + base=`${BASENAME} $$test .c` ; \ + (for fmt in ${TEST_FORMATS} E ; do \ + echo "... $$test ... $$fmt ..."; \ + ${CP} out/$$base.$$fmt.out ${srcdir}/saved/$$base.$$fmt.out ; \ + ${CP} out/$$base.$$fmt.err ${srcdir}/saved/$$base.$$fmt.err ; \ + done) \ + done) + -@(test=test_01.c; base=test_01; for fmt in Ecsv1 Ecsv2 Ecsv3 ; do \ + echo "... $$test ... $$fmt ..."; \ + ${CP} out/$$base.$$fmt.out ${srcdir}/saved/$$base.$$fmt.out ; \ + ${CP} out/$$base.$$fmt.err ${srcdir}/saved/$$base.$$fmt.err ; \ + done) + +.c.test: + $(AM_V_CC)$(LTCOMPILE) -MT $@ -MD -MP -MF $(DEPDIR)/$*.Tpo -o $@ $< + +CLEANFILES = ${TEST_CASES:.c=.test} +CLEANDIRS = out + +clean-local: + rm -rf ${CLEANDIRS} diff --git a/contrib/libxo/tests/core/saved/test_01.E.err b/contrib/libxo/tests/core/saved/test_01.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.E.err diff --git a/contrib/libxo/tests/core/saved/test_01.E.out b/contrib/libxo/tests/core/saved/test_01.E.out new file mode 100644 index 000000000000..506bfa83526f --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.E.out @@ -0,0 +1,206 @@ +op create: [test] [] [0] +op open_container: [top-level] [] [0x810] +op string: [type] [ethernet] [0] +op content: [type] [bridge] [0] +op content: [type] [18u] [0] +op content: [type] [24] [0] +op content: [address] [0x0] [0] +op content: [port] [1] [0] +op content: [address] [0x0] [0] +op content: [port] [1] [0] +op content: [address] [0x0] [0] +op content: [port] [1] [0] +op content: [used-percent] [12] [0] +op content: [kve_start] [0xdeadbeef] [0x8] +op content: [kve_end] [0xcabb1e] [0x8] +op string: [host] [my-box] [0x200000] +op string: [domain] [example.com] [0x200000] +op string: [host] [my-box] [0x200008] +op string: [domain] [example.com] [0x200000] +op string: [label] [value] [0x200000] +op string: [max-chaos] [very] [0x1000] +op content: [min-chaos] [42] [0] +op string: [some-chaos] [[42]] [0] +op attr: [test-attr] [attr-value] [0] +op open_leaf_list: [sku] [] [0] +op string: [sku] [gum-000-1412] [0x2010] +op close_leaf_list: [sku] [] [0] +op string: [host] [my-box] [0] +op string: [domain] [example.com] [0] +op attr: [test] [value] [0] +op open_container: [data] [] [0x810] +op open_list: [item] [] [0] +op attr: [test2] [value2] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [GRO-000-415] [0x98] +op string: [name] [gum] [0x80] +op content: [sold] [1412] [0x20] +op content: [in-stock] [54] [0] +op content: [on-order] [10] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-212] [0x98] +op string: [name] [rope] [0x80] +op content: [sold] [85] [0x20] +op content: [in-stock] [4] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-517] [0x98] +op string: [name] [ladder] [0x80] +op content: [sold] [0] [0x20] +op content: [in-stock] [2] [0] +op content: [on-order] [1] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-632] [0x98] +op string: [name] [bolt] [0x80] +op content: [sold] [4123] [0x20] +op content: [in-stock] [144] [0] +op content: [on-order] [42] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [GRO-000-2331] [0x98] +op string: [name] [water] [0x80] +op content: [sold] [17] [0x20] +op content: [in-stock] [14] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data] [] [0] +op open_container: [data2] [] [0x810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [sku] [GRO-000-415] [0x98] +op string: [name] [gum] [0x80] +op content: [sold] [1412.0] [0x20] +op content: [in-stock] [54] [0] +op content: [on-order] [10] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [sku] [HRD-000-212] [0x98] +op string: [name] [rope] [0x80] +op content: [sold] [85.0] [0x20] +op content: [in-stock] [4] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [sku] [HRD-000-517] [0x98] +op string: [name] [ladder] [0x80] +op content: [sold] [0] [0x20] +op content: [in-stock] [2] [0] +op content: [on-order] [1] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [sku] [HRD-000-632] [0x98] +op string: [name] [bolt] [0x80] +op content: [sold] [4123.0] [0x20] +op content: [in-stock] [144] [0] +op content: [on-order] [42] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [sku] [GRO-000-2331] [0x98] +op string: [name] [water] [0x80] +op content: [sold] [17.0] [0x20] +op content: [in-stock] [14] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data2] [] [0] +op open_container: [data3] [] [0x810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [sku] [GRO-000-533] [0x98] +op string: [name] [fish] [0x80] +op content: [sold] [1321.0] [0x20] +op content: [in-stock] [45] [0] +op content: [on-order] [1] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data3] [] [0] +op open_container: [data4] [] [0x810] +op open_list: [item] [] [0] +op attr: [test4] [value4] [0] +op string: [item] [gum] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [rope] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [ladder] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [bolt] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [water] [0x2000] +op close_list: [item] [] [0] +op close_container: [data4] [] [0] +op attr: [test] [value] [0] +op open_container: [data] [] [0x810] +op open_list: [item] [] [0] +op attr: [test2] [value2] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [GRO-000-415] [0x98] +op string: [name] [gum] [0x80] +op content: [sold] [1412] [0x20] +op content: [on-order] [10] [0] +op content: [in-stock] [54] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-212] [0x98] +op string: [name] [rope] [0x80] +op content: [sold] [85] [0x20] +op string: [extra] [special] [0] +op content: [on-order] [2] [0] +op content: [in-stock] [4] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-517] [0x98] +op string: [name] [ladder] [0x80] +op content: [sold] [0] [0x20] +op string: [extra] [special] [0] +op content: [on-order] [1] [0] +op content: [in-stock] [2] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-632] [0x98] +op string: [name] [bolt] [0x80] +op content: [sold] [4123] [0x20] +op content: [on-order] [42] [0] +op content: [in-stock] [144] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op attr: [test3] [value3] [0] +op string: [sku] [GRO-000-2331] [0x98] +op string: [name] [water] [0x80] +op content: [sold] [17] [0x20] +op string: [extra] [special] [0] +op content: [on-order] [2] [0] +op content: [in-stock] [14] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data] [] [0] +op content: [cost] [425] [0] +op content: [cost] [455] [0] +op string: [mode] [mode] [0x8] +op string: [mode_octal] [octal] [0x8] +op string: [links] [links] [0x1000] +op string: [user] [user] [0x1000] +op string: [group] [group] [0x1000] +op string: [pre] [that] [0x8] +op content: [links] [3] [0x1000] +op string: [post] [this] [0x1000] +op string: [mode] [/some/file] [0x1000] +op content: [mode_octal] [640] [0x8] +op content: [links] [1] [0x1000] +op string: [user] [user] [0x1000] +op string: [group] [group] [0x1000] +op close_container: [top-level] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_01.Ecsv1.err b/contrib/libxo/tests/core/saved/test_01.Ecsv1.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.Ecsv1.err diff --git a/contrib/libxo/tests/core/saved/test_01.Ecsv1.out b/contrib/libxo/tests/core/saved/test_01.Ecsv1.out new file mode 100644 index 000000000000..aa1d9db49f38 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.Ecsv1.out @@ -0,0 +1,17 @@ +sku,name,sold,in-stock,on-order +GRO-000-415,gum,1412,54,10 +HRD-000-212,rope,85,4,2 +HRD-000-517,ladder,0,2,1 +HRD-000-632,bolt,4123,144,42 +GRO-000-2331,water,17,14,2 +GRO-000-415,gum,1412.0,54,10 +HRD-000-212,rope,85.0,4,2 +HRD-000-517,ladder,0,2,1 +HRD-000-632,bolt,4123.0,144,42 +GRO-000-2331,water,17.0,14,2 +GRO-000-533,fish,1321.0,45,1 +GRO-000-415,gum,1412,54,10 +HRD-000-212,rope,85,4,2 +HRD-000-517,ladder,0,2,1 +HRD-000-632,bolt,4123,144,42 +GRO-000-2331,water,17,14,2 diff --git a/contrib/libxo/tests/core/saved/test_01.Ecsv2.err b/contrib/libxo/tests/core/saved/test_01.Ecsv2.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.Ecsv2.err diff --git a/contrib/libxo/tests/core/saved/test_01.Ecsv2.out b/contrib/libxo/tests/core/saved/test_01.Ecsv2.out new file mode 100644 index 000000000000..b39499961d67 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.Ecsv2.out @@ -0,0 +1,10 @@ +GRO-000-415,gum,1412,54,10 +HRD-000-212,rope,85,4,2 +HRD-000-517,ladder,0,2,1 +HRD-000-632,bolt,4123,144,42 +GRO-000-2331,water,17,14,2 +GRO-000-415,gum,1412,54,10 +HRD-000-212,rope,85,4,2 +HRD-000-517,ladder,0,2,1 +HRD-000-632,bolt,4123,144,42 +GRO-000-2331,water,17,14,2 diff --git a/contrib/libxo/tests/core/saved/test_01.Ecsv3.err b/contrib/libxo/tests/core/saved/test_01.Ecsv3.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.Ecsv3.err diff --git a/contrib/libxo/tests/core/saved/test_01.Ecsv3.out b/contrib/libxo/tests/core/saved/test_01.Ecsv3.out new file mode 100644 index 000000000000..6f1da35193be --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.Ecsv3.out @@ -0,0 +1,17 @@ +sku,sold +GRO-000-415,1412 +HRD-000-212,85 +HRD-000-517,0 +HRD-000-632,4123 +GRO-000-2331,17 +GRO-000-415,1412.0 +HRD-000-212,85.0 +HRD-000-517,0 +HRD-000-632,4123.0 +GRO-000-2331,17.0 +GRO-000-533,1321.0 +GRO-000-415,1412 +HRD-000-212,85 +HRD-000-517,0 +HRD-000-632,4123 +GRO-000-2331,17 diff --git a/contrib/libxo/tests/core/saved/test_01.H.err b/contrib/libxo/tests/core/saved/test_01.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.H.err diff --git a/contrib/libxo/tests/core/saved/test_01.H.out b/contrib/libxo/tests/core/saved/test_01.H.out new file mode 100644 index 000000000000..b58816d8617f --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.H.out @@ -0,0 +1,3 @@ +<div class="line"><div class="text">static </div><div class="data" data-tag="type">ethernet</div><div class="text"> </div><div class="data" data-tag="type">bridge</div><div class="text"> </div><div class="data" data-tag="type"> 18u</div><div class="text"> </div><div class="data" data-tag="type"> 24</div><div class="text">anchor </div><div class="padding"> </div><div class="data" data-tag="address">0x0</div><div class="text">..</div><div class="data" data-tag="port">1</div></div><div class="line"><div class="text">anchor </div><div class="padding"> </div><div class="data" data-tag="address">0x0</div><div class="text">..</div><div class="data" data-tag="port">1</div></div><div class="line"><div class="text">anchor </div><div class="padding"> </div><div class="data" data-tag="address">0x0</div><div class="text">..</div><div class="data" data-tag="port">1</div></div><div class="line"><div class="text">df </div><div class="data" data-tag="used-percent"> 12</div><div class="units">%</div></div><div class="line"><div class="text">testing argument modifier </div><div class="data" data-tag="host">my-box</div><div class="text">.</div><div class="data" data-tag="domain">example.com</div><div class="text">...</div></div><div class="line"><div class="text">testing argument modifier with encoding to </div><div class="text">.</div><div class="data" data-tag="domain">example.com</div><div class="text">...</div></div><div class="line"><div class="label">Label text</div><div class="text"> </div><div class="data" data-tag="label">value</div></div><div class="line"><div class="title">My Title +</div><div class="data" data-tag="max-chaos"> very </div><div class="data" data-tag="min-chaos">42</div><div class="data" data-tag="some-chaos">42 +</div><div class="data" data-tag="sku">gum-1412</div><div class="text">Connecting to </div><div class="data" data-tag="host">my-box</div><div class="text">.</div><div class="data" data-tag="domain">example.com</div><div class="text">...</div></div><div class="line"><div class="title">Item </div><div class="title"> Total Sold</div><div class="title"> In Stock</div><div class="title"> On Order</div><div class="title"> SKU</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="sold"> 1412</div><div class="data" data-tag="in-stock"> 54</div><div class="data" data-tag="on-order"> 10</div><div class="data" data-tag="sku" data-key="key"> GRO-000-415</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="sold"> 85</div><div class="data" data-tag="in-stock"> 4</div><div class="data" data-tag="on-order"> 2</div><div class="data" data-tag="sku" data-key="key"> HRD-000-212</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="sold"> 0</div><div class="data" data-tag="in-stock"> 2</div><div class="data" data-tag="on-order"> 1</div><div class="data" data-tag="sku" data-key="key"> HRD-000-517</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="sold"> 4123</div><div class="data" data-tag="in-stock"> 144</div><div class="data" data-tag="on-order"> 42</div><div class="data" data-tag="sku" data-key="key"> HRD-000-632</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="sold"> 17</div><div class="data" data-tag="in-stock"> 14</div><div class="data" data-tag="on-order"> 2</div><div class="data" data-tag="sku" data-key="key"> GRO-000-2331</div></div><div class="line"></div><div class="line"></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">gum</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">1412.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">54</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">10</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">GRO-000-415</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">rope</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">85.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">4</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">2</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">HRD-000-212</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">ladder</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">2</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">1</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">HRD-000-517</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">bolt</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">4123.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">144</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">42</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">HRD-000-632</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">water</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">17.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">14</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">2</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">GRO-000-2331</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">fish</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">1321.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">45</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">1</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">GRO-000-533</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">gum</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">rope</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">ladder</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">bolt</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">water</div></div><div class="line"><div class="title">Item </div><div class="title"> Total Sold</div><div class="title"> In Stock</div><div class="title"> On Order</div><div class="title"> SKU</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="sold"> 1412</div><div class="data" data-tag="on-order"> 10</div><div class="data" data-tag="in-stock"> 54</div><div class="data" data-tag="sku" data-key="key"> GRO-000-415</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="sold"> 85</div><div class="text">Extra: </div><div class="data" data-tag="extra">special</div><div class="data" data-tag="on-order"> 2</div><div class="data" data-tag="in-stock"> 4</div><div class="data" data-tag="sku" data-key="key"> HRD-000-212</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="sold"> 0</div><div class="text">Extra: </div><div class="data" data-tag="extra">special</div><div class="data" data-tag="on-order"> 1</div><div class="data" data-tag="in-stock"> 2</div><div class="data" data-tag="sku" data-key="key"> HRD-000-517</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="sold"> 4123</div><div class="data" data-tag="on-order"> 42</div><div class="data" data-tag="in-stock"> 144</div><div class="data" data-tag="sku" data-key="key"> HRD-000-632</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="sold"> 17</div><div class="text">Extra: </div><div class="data" data-tag="extra">special</div><div class="data" data-tag="on-order"> 2</div><div class="data" data-tag="in-stock"> 14</div><div class="data" data-tag="sku" data-key="key"> GRO-000-2331</div></div><div class="line"></div><div class="line"></div><div class="line"><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div></div><div class="line"><div class="text">X</div><div class="padding"> </div><div class="text">X</div><div class="label">Cost</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="cost">425</div></div><div class="line"><div class="text">X</div><div class="padding"> </div><div class="text">X</div><div class="label">Cost</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="cost">455</div></div><div class="line"><div class="text"> </div><div class="data" data-tag="links">links</div><div class="text"> </div><div class="data" data-tag="user">user</div><div class="text"> </div><div class="data" data-tag="group">group</div><div class="text"> </div></div><div class="line"><div class="data" data-tag="links">3 </div><div class="data" data-tag="post">this </div></div><div class="line"><div class="data" data-tag="mode">/some/file</div><div class="text"> </div><div class="data" data-tag="links"> 1</div><div class="text"> </div><div class="data" data-tag="user">user </div><div class="text"> </div><div class="data" data-tag="group">group </div><div class="text"> </div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_01.HIPx.err b/contrib/libxo/tests/core/saved/test_01.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_01.HIPx.out b/contrib/libxo/tests/core/saved/test_01.HIPx.out new file mode 100644 index 000000000000..da30b72ab7ec --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.HIPx.out @@ -0,0 +1,437 @@ +<div class="line"> + <div class="text">static </div> + <div class="data" data-tag="type" data-xpath="/top-level/type">ethernet</div> + <div class="text"> </div> + <div class="data" data-tag="type" data-xpath="/top-level/type">bridge</div> + <div class="text"> </div> + <div class="data" data-tag="type" data-xpath="/top-level/type"> 18u</div> + <div class="text"> </div> + <div class="data" data-tag="type" data-xpath="/top-level/type"> 24</div> + <div class="text">anchor </div> + <div class="padding"> </div> + <div class="data" data-tag="address" data-xpath="/top-level/address">0x0</div> + <div class="text">..</div> + <div class="data" data-tag="port" data-xpath="/top-level/port">1</div> +</div> +<div class="line"> + <div class="text">anchor </div> + <div class="padding"> </div> + <div class="data" data-tag="address" data-xpath="/top-level/address">0x0</div> + <div class="text">..</div> + <div class="data" data-tag="port" data-xpath="/top-level/port">1</div> +</div> +<div class="line"> + <div class="text">anchor </div> + <div class="padding"> </div> + <div class="data" data-tag="address" data-xpath="/top-level/address">0x0</div> + <div class="text">..</div> + <div class="data" data-tag="port" data-xpath="/top-level/port">1</div> +</div> +<div class="line"> + <div class="text">df </div> + <div class="data" data-tag="used-percent" data-xpath="/top-level/used-percent"> 12</div> + <div class="units">%</div> +</div> +<div class="line"> + <div class="text">testing argument modifier </div> + <div class="data" data-tag="host" data-xpath="/top-level/host">my-box</div> + <div class="text">.</div> + <div class="data" data-tag="domain" data-xpath="/top-level/domain">example.com</div> + <div class="text">...</div> +</div> +<div class="line"> + <div class="text">testing argument modifier with encoding to </div> + <div class="text">.</div> + <div class="data" data-tag="domain" data-xpath="/top-level/domain">example.com</div> + <div class="text">...</div> +</div> +<div class="line"> + <div class="label">Label text</div> + <div class="text"> </div> + <div class="data" data-tag="label" data-xpath="/top-level/label">value</div> +</div> +<div class="line"> + <div class="title">My Title +</div> + <div class="data" data-tag="max-chaos" data-xpath="/top-level/max-chaos"> very </div> + <div class="data" data-tag="min-chaos" data-xpath="/top-level/min-chaos">42</div> + <div class="data" data-tag="some-chaos" data-xpath="/top-level/some-chaos">42 +</div> + <div class="data" data-tag="sku" data-xpath="/top-level/sku" data-type="string" data-help="Stock Keeping Unit">gum-1412</div> + <div class="text">Connecting to </div> + <div class="data" data-tag="host" data-xpath="/top-level/host">my-box</div> + <div class="text">.</div> + <div class="data" data-tag="domain" data-xpath="/top-level/domain">example.com</div> + <div class="text">...</div> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Total Sold</div> + <div class="title"> In Stock</div> + <div class="title"> On Order</div> + <div class="title"> SKU</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">gum </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'GRO-000-415'][name = 'gum']/sold" data-type="number" data-help="Number of items sold"> 1412</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'GRO-000-415'][name = 'gum']/in-stock" data-type="number" data-help="Number of items in stock"> 54</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'GRO-000-415'][name = 'gum']/on-order" data-type="number" data-help="Number of items on order"> 10</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> GRO-000-415</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">rope </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/sold" data-type="number" data-help="Number of items sold"> 85</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/in-stock" data-type="number" data-help="Number of items in stock"> 4</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/on-order" data-type="number" data-help="Number of items on order"> 2</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-212</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">ladder </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/sold" data-type="number" data-help="Number of items sold"> 0</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/in-stock" data-type="number" data-help="Number of items in stock"> 2</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/on-order" data-type="number" data-help="Number of items on order"> 1</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-517</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">bolt </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'HRD-000-632'][name = 'bolt']/sold" data-type="number" data-help="Number of items sold"> 4123</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'HRD-000-632'][name = 'bolt']/in-stock" data-type="number" data-help="Number of items in stock"> 144</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'HRD-000-632'][name = 'bolt']/on-order" data-type="number" data-help="Number of items on order"> 42</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-632</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">water </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/sold" data-type="number" data-help="Number of items sold"> 17</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/in-stock" data-type="number" data-help="Number of items in stock"> 14</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/on-order" data-type="number" data-help="Number of items on order"> 2</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> GRO-000-2331</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top-level/data2/item/name" data-type="string" data-help="Name of the item" data-key="key">gum</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data2/item[sku = 'GRO-000-415'][name = 'gum']/sold" data-type="number" data-help="Number of items sold">1412.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data2/item[sku = 'GRO-000-415'][name = 'gum']/in-stock" data-type="number" data-help="Number of items in stock">54</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data2/item[sku = 'GRO-000-415'][name = 'gum']/on-order" data-type="number" data-help="Number of items on order">10</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top-level/data2/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">GRO-000-415</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top-level/data2/item/name" data-type="string" data-help="Name of the item" data-key="key">rope</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data2/item[sku = 'HRD-000-212'][name = 'rope']/sold" data-type="number" data-help="Number of items sold">85.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data2/item[sku = 'HRD-000-212'][name = 'rope']/in-stock" data-type="number" data-help="Number of items in stock">4</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data2/item[sku = 'HRD-000-212'][name = 'rope']/on-order" data-type="number" data-help="Number of items on order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top-level/data2/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">HRD-000-212</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top-level/data2/item/name" data-type="string" data-help="Name of the item" data-key="key">ladder</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data2/item[sku = 'HRD-000-517'][name = 'ladder']/sold" data-type="number" data-help="Number of items sold">0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data2/item[sku = 'HRD-000-517'][name = 'ladder']/in-stock" data-type="number" data-help="Number of items in stock">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data2/item[sku = 'HRD-000-517'][name = 'ladder']/on-order" data-type="number" data-help="Number of items on order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top-level/data2/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">HRD-000-517</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top-level/data2/item/name" data-type="string" data-help="Name of the item" data-key="key">bolt</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data2/item[sku = 'HRD-000-632'][name = 'bolt']/sold" data-type="number" data-help="Number of items sold">4123.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data2/item[sku = 'HRD-000-632'][name = 'bolt']/in-stock" data-type="number" data-help="Number of items in stock">144</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data2/item[sku = 'HRD-000-632'][name = 'bolt']/on-order" data-type="number" data-help="Number of items on order">42</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top-level/data2/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">HRD-000-632</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top-level/data2/item/name" data-type="string" data-help="Name of the item" data-key="key">water</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data2/item[sku = 'GRO-000-2331'][name = 'water']/sold" data-type="number" data-help="Number of items sold">17.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data2/item[sku = 'GRO-000-2331'][name = 'water']/in-stock" data-type="number" data-help="Number of items in stock">14</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data2/item[sku = 'GRO-000-2331'][name = 'water']/on-order" data-type="number" data-help="Number of items on order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top-level/data2/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">GRO-000-2331</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top-level/data3/item/name" data-type="string" data-help="Name of the item" data-key="key">fish</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data3/item[sku = 'GRO-000-533'][name = 'fish']/sold" data-type="number" data-help="Number of items sold">1321.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data3/item[sku = 'GRO-000-533'][name = 'fish']/in-stock" data-type="number" data-help="Number of items in stock">45</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data3/item[sku = 'GRO-000-533'][name = 'fish']/on-order" data-type="number" data-help="Number of items on order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top-level/data3/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">GRO-000-533</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top-level/data4/item">gum</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top-level/data4/item">rope</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top-level/data4/item">ladder</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top-level/data4/item">bolt</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top-level/data4/item">water</div> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Total Sold</div> + <div class="title"> In Stock</div> + <div class="title"> On Order</div> + <div class="title"> SKU</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">gum </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'GRO-000-415'][name = 'gum']/sold" data-type="number" data-help="Number of items sold"> 1412</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'GRO-000-415'][name = 'gum']/on-order" data-type="number" data-help="Number of items on order"> 10</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'GRO-000-415'][name = 'gum']/in-stock" data-type="number" data-help="Number of items in stock"> 54</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> GRO-000-415</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">rope </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/sold" data-type="number" data-help="Number of items sold"> 85</div> + <div class="text">Extra: </div> + <div class="data" data-tag="extra" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/extra">special</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/on-order" data-type="number" data-help="Number of items on order"> 2</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'HRD-000-212'][name = 'rope']/in-stock" data-type="number" data-help="Number of items in stock"> 4</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-212</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">ladder </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/sold" data-type="number" data-help="Number of items sold"> 0</div> + <div class="text">Extra: </div> + <div class="data" data-tag="extra" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/extra">special</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/on-order" data-type="number" data-help="Number of items on order"> 1</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'HRD-000-517'][name = 'ladder']/in-stock" data-type="number" data-help="Number of items in stock"> 2</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-517</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">bolt </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'HRD-000-632'][name = 'bolt']/sold" data-type="number" data-help="Number of items sold"> 4123</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'HRD-000-632'][name = 'bolt']/on-order" data-type="number" data-help="Number of items on order"> 42</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'HRD-000-632'][name = 'bolt']/in-stock" data-type="number" data-help="Number of items in stock"> 144</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-632</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top-level/data/item/name" data-type="string" data-help="Name of the item" data-key="key">water </div> + <div class="data" data-tag="sold" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/sold" data-type="number" data-help="Number of items sold"> 17</div> + <div class="text">Extra: </div> + <div class="data" data-tag="extra" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/extra">special</div> + <div class="data" data-tag="on-order" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/on-order" data-type="number" data-help="Number of items on order"> 2</div> + <div class="data" data-tag="in-stock" data-xpath="/top-level/data/item[sku = 'GRO-000-2331'][name = 'water']/in-stock" data-type="number" data-help="Number of items in stock"> 14</div> + <div class="data" data-tag="sku" data-xpath="/top-level/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> GRO-000-2331</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost" data-xpath="/top-level/cost">425</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost" data-xpath="/top-level/cost">455</div> +</div> +<div class="line"> + <div class="text"> </div> + <div class="data" data-tag="links" data-xpath="/top-level/links">links</div> + <div class="text"> </div> + <div class="data" data-tag="user" data-xpath="/top-level/user">user</div> + <div class="text"> </div> + <div class="data" data-tag="group" data-xpath="/top-level/group">group</div> + <div class="text"> </div> +</div> +<div class="line"> + <div class="data" data-tag="links" data-xpath="/top-level/links">3 </div> + <div class="data" data-tag="post" data-xpath="/top-level/post">this </div> +</div> +<div class="line"> + <div class="data" data-tag="mode" data-xpath="/top-level/mode">/some/file</div> + <div class="text"> </div> + <div class="data" data-tag="links" data-xpath="/top-level/links"> 1</div> + <div class="text"> </div> + <div class="data" data-tag="user" data-xpath="/top-level/user">user </div> + <div class="text"> </div> + <div class="data" data-tag="group" data-xpath="/top-level/group">group </div> + <div class="text"> </div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_01.HP.err b/contrib/libxo/tests/core/saved/test_01.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.HP.err diff --git a/contrib/libxo/tests/core/saved/test_01.HP.out b/contrib/libxo/tests/core/saved/test_01.HP.out new file mode 100644 index 000000000000..5a7aed05ac0b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.HP.out @@ -0,0 +1,437 @@ +<div class="line"> + <div class="text">static </div> + <div class="data" data-tag="type">ethernet</div> + <div class="text"> </div> + <div class="data" data-tag="type">bridge</div> + <div class="text"> </div> + <div class="data" data-tag="type"> 18u</div> + <div class="text"> </div> + <div class="data" data-tag="type"> 24</div> + <div class="text">anchor </div> + <div class="padding"> </div> + <div class="data" data-tag="address">0x0</div> + <div class="text">..</div> + <div class="data" data-tag="port">1</div> +</div> +<div class="line"> + <div class="text">anchor </div> + <div class="padding"> </div> + <div class="data" data-tag="address">0x0</div> + <div class="text">..</div> + <div class="data" data-tag="port">1</div> +</div> +<div class="line"> + <div class="text">anchor </div> + <div class="padding"> </div> + <div class="data" data-tag="address">0x0</div> + <div class="text">..</div> + <div class="data" data-tag="port">1</div> +</div> +<div class="line"> + <div class="text">df </div> + <div class="data" data-tag="used-percent"> 12</div> + <div class="units">%</div> +</div> +<div class="line"> + <div class="text">testing argument modifier </div> + <div class="data" data-tag="host">my-box</div> + <div class="text">.</div> + <div class="data" data-tag="domain">example.com</div> + <div class="text">...</div> +</div> +<div class="line"> + <div class="text">testing argument modifier with encoding to </div> + <div class="text">.</div> + <div class="data" data-tag="domain">example.com</div> + <div class="text">...</div> +</div> +<div class="line"> + <div class="label">Label text</div> + <div class="text"> </div> + <div class="data" data-tag="label">value</div> +</div> +<div class="line"> + <div class="title">My Title +</div> + <div class="data" data-tag="max-chaos"> very </div> + <div class="data" data-tag="min-chaos">42</div> + <div class="data" data-tag="some-chaos">42 +</div> + <div class="data" data-tag="sku">gum-1412</div> + <div class="text">Connecting to </div> + <div class="data" data-tag="host">my-box</div> + <div class="text">.</div> + <div class="data" data-tag="domain">example.com</div> + <div class="text">...</div> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Total Sold</div> + <div class="title"> In Stock</div> + <div class="title"> On Order</div> + <div class="title"> SKU</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="sold"> 1412</div> + <div class="data" data-tag="in-stock"> 54</div> + <div class="data" data-tag="on-order"> 10</div> + <div class="data" data-tag="sku" data-key="key"> GRO-000-415</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="sold"> 85</div> + <div class="data" data-tag="in-stock"> 4</div> + <div class="data" data-tag="on-order"> 2</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-212</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="sold"> 0</div> + <div class="data" data-tag="in-stock"> 2</div> + <div class="data" data-tag="on-order"> 1</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-517</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="sold"> 4123</div> + <div class="data" data-tag="in-stock"> 144</div> + <div class="data" data-tag="on-order"> 42</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-632</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="sold"> 17</div> + <div class="data" data-tag="in-stock"> 14</div> + <div class="data" data-tag="on-order"> 2</div> + <div class="data" data-tag="sku" data-key="key"> GRO-000-2331</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">gum</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">1412.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">54</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">10</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">GRO-000-415</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">rope</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">85.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">4</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">HRD-000-212</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">ladder</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">HRD-000-517</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">bolt</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">4123.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">144</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">42</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">HRD-000-632</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">water</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">17.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">14</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">GRO-000-2331</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">fish</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">1321.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">45</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">GRO-000-533</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">gum</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">rope</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">ladder</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">bolt</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">water</div> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Total Sold</div> + <div class="title"> In Stock</div> + <div class="title"> On Order</div> + <div class="title"> SKU</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="sold"> 1412</div> + <div class="data" data-tag="on-order"> 10</div> + <div class="data" data-tag="in-stock"> 54</div> + <div class="data" data-tag="sku" data-key="key"> GRO-000-415</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="sold"> 85</div> + <div class="text">Extra: </div> + <div class="data" data-tag="extra">special</div> + <div class="data" data-tag="on-order"> 2</div> + <div class="data" data-tag="in-stock"> 4</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-212</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="sold"> 0</div> + <div class="text">Extra: </div> + <div class="data" data-tag="extra">special</div> + <div class="data" data-tag="on-order"> 1</div> + <div class="data" data-tag="in-stock"> 2</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-517</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="sold"> 4123</div> + <div class="data" data-tag="on-order"> 42</div> + <div class="data" data-tag="in-stock"> 144</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-632</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="sold"> 17</div> + <div class="text">Extra: </div> + <div class="data" data-tag="extra">special</div> + <div class="data" data-tag="on-order"> 2</div> + <div class="data" data-tag="in-stock"> 14</div> + <div class="data" data-tag="sku" data-key="key"> GRO-000-2331</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost">425</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost">455</div> +</div> +<div class="line"> + <div class="text"> </div> + <div class="data" data-tag="links">links</div> + <div class="text"> </div> + <div class="data" data-tag="user">user</div> + <div class="text"> </div> + <div class="data" data-tag="group">group</div> + <div class="text"> </div> +</div> +<div class="line"> + <div class="data" data-tag="links">3 </div> + <div class="data" data-tag="post">this </div> +</div> +<div class="line"> + <div class="data" data-tag="mode">/some/file</div> + <div class="text"> </div> + <div class="data" data-tag="links"> 1</div> + <div class="text"> </div> + <div class="data" data-tag="user">user </div> + <div class="text"> </div> + <div class="data" data-tag="group">group </div> + <div class="text"> </div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_01.J.err b/contrib/libxo/tests/core/saved/test_01.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.J.err diff --git a/contrib/libxo/tests/core/saved/test_01.J.out b/contrib/libxo/tests/core/saved/test_01.J.out new file mode 100644 index 000000000000..b8c782677916 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.J.out @@ -0,0 +1 @@ +{"top-level": {"type":"ethernet","type":"bridge","type":"18u","type":24,"address":"0x0","port":1,"address":"0x0","port":1,"address":"0x0","port":1,"used-percent":12,"kve_start":"0xdeadbeef","kve_end":"0xcabb1e","host":"my-box","domain":"example.com","host":"my-box","domain":"example.com","label":"value","max-chaos":"very","min-chaos":42,"some-chaos":"[42]", "sku": ["gum-000-1412"],"host":"my-box","domain":"example.com", "data": {"item": [{"sku":"GRO-000-415","name":"gum","sold":1412,"in-stock":54,"on-order":10}, {"sku":"HRD-000-212","name":"rope","sold":85,"in-stock":4,"on-order":2}, {"sku":"HRD-000-517","name":"ladder","sold":0,"in-stock":2,"on-order":1}, {"sku":"HRD-000-632","name":"bolt","sold":4123,"in-stock":144,"on-order":42}, {"sku":"GRO-000-2331","name":"water","sold":17,"in-stock":14,"on-order":2}]}, "data2": {"item": [{"sku":"GRO-000-415","name":"gum","sold":1412.0,"in-stock":54,"on-order":10}, {"sku":"HRD-000-212","name":"rope","sold":85.0,"in-stock":4,"on-order":2}, {"sku":"HRD-000-517","name":"ladder","sold":0,"in-stock":2,"on-order":1}, {"sku":"HRD-000-632","name":"bolt","sold":4123.0,"in-stock":144,"on-order":42}, {"sku":"GRO-000-2331","name":"water","sold":17.0,"in-stock":14,"on-order":2}]}, "data3": {"item": [{"sku":"GRO-000-533","name":"fish","sold":1321.0,"in-stock":45,"on-order":1}]}, "data4": {"item": ["gum","rope","ladder","bolt","water"]}, "data": {"item": [{"sku":"GRO-000-415","name":"gum","sold":1412,"on-order":10,"in-stock":54}, {"sku":"HRD-000-212","name":"rope","sold":85,"extra":"special","on-order":2,"in-stock":4}, {"sku":"HRD-000-517","name":"ladder","sold":0,"extra":"special","on-order":1,"in-stock":2}, {"sku":"HRD-000-632","name":"bolt","sold":4123,"on-order":42,"in-stock":144}, {"sku":"GRO-000-2331","name":"water","sold":17,"extra":"special","on-order":2,"in-stock":14}]},"cost":425,"cost":455,"mode":"mode","mode_octal":"octal","links":"links","user":"user","group":"group","pre":"that","links":3,"post":"this","mode":"/some/file","mode_octal":640,"links":1,"user":"user","group":"group"}} diff --git a/contrib/libxo/tests/core/saved/test_01.JP.err b/contrib/libxo/tests/core/saved/test_01.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.JP.err diff --git a/contrib/libxo/tests/core/saved/test_01.JP.out b/contrib/libxo/tests/core/saved/test_01.JP.out new file mode 100644 index 000000000000..71a77cea81df --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.JP.out @@ -0,0 +1,185 @@ +{ + "top-level": { + "type": "ethernet", + "type": "bridge", + "type": "18u", + "type": 24, + "address": "0x0", + "port": 1, + "address": "0x0", + "port": 1, + "address": "0x0", + "port": 1, + "used-percent": 12, + "kve_start": "0xdeadbeef", + "kve_end": "0xcabb1e", + "host": "my-box", + "domain": "example.com", + "host": "my-box", + "domain": "example.com", + "label": "value", + "max-chaos": "very", + "min-chaos": 42, + "some-chaos": "[42]", + "sku": [ + "gum-000-1412" + ], + "host": "my-box", + "domain": "example.com", + "data": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412, + "in-stock": 54, + "on-order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85, + "in-stock": 4, + "on-order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in-stock": 2, + "on-order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123, + "in-stock": 144, + "on-order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17, + "in-stock": 14, + "on-order": 2 + } + ] + }, + "data2": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412.0, + "in-stock": 54, + "on-order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85.0, + "in-stock": 4, + "on-order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in-stock": 2, + "on-order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123.0, + "in-stock": 144, + "on-order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17.0, + "in-stock": 14, + "on-order": 2 + } + ] + }, + "data3": { + "item": [ + { + "sku": "GRO-000-533", + "name": "fish", + "sold": 1321.0, + "in-stock": 45, + "on-order": 1 + } + ] + }, + "data4": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "data": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412, + "on-order": 10, + "in-stock": 54 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85, + "extra": "special", + "on-order": 2, + "in-stock": 4 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "extra": "special", + "on-order": 1, + "in-stock": 2 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123, + "on-order": 42, + "in-stock": 144 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17, + "extra": "special", + "on-order": 2, + "in-stock": 14 + } + ] + }, + "cost": 425, + "cost": 455, + "mode": "mode", + "mode_octal": "octal", + "links": "links", + "user": "user", + "group": "group", + "pre": "that", + "links": 3, + "post": "this", + "mode": "/some/file", + "mode_octal": 640, + "links": 1, + "user": "user", + "group": "group" + } +} diff --git a/contrib/libxo/tests/core/saved/test_01.JPu.err b/contrib/libxo/tests/core/saved/test_01.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_01.JPu.out b/contrib/libxo/tests/core/saved/test_01.JPu.out new file mode 100644 index 000000000000..747db16f07a7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.JPu.out @@ -0,0 +1,185 @@ +{ + "top_level": { + "type": "ethernet", + "type": "bridge", + "type": "18u", + "type": 24, + "address": "0x0", + "port": 1, + "address": "0x0", + "port": 1, + "address": "0x0", + "port": 1, + "used_percent": 12, + "kve_start": "0xdeadbeef", + "kve_end": "0xcabb1e", + "host": "my-box", + "domain": "example.com", + "host": "my-box", + "domain": "example.com", + "label": "value", + "max_chaos": "very", + "min_chaos": 42, + "some_chaos": "[42]", + "sku": [ + "gum-000-1412" + ], + "host": "my-box", + "domain": "example.com", + "data": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412, + "in_stock": 54, + "on_order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85, + "in_stock": 4, + "on_order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in_stock": 2, + "on_order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123, + "in_stock": 144, + "on_order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17, + "in_stock": 14, + "on_order": 2 + } + ] + }, + "data2": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412.0, + "in_stock": 54, + "on_order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85.0, + "in_stock": 4, + "on_order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in_stock": 2, + "on_order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123.0, + "in_stock": 144, + "on_order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17.0, + "in_stock": 14, + "on_order": 2 + } + ] + }, + "data3": { + "item": [ + { + "sku": "GRO-000-533", + "name": "fish", + "sold": 1321.0, + "in_stock": 45, + "on_order": 1 + } + ] + }, + "data4": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "data": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412, + "on_order": 10, + "in_stock": 54 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85, + "extra": "special", + "on_order": 2, + "in_stock": 4 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "extra": "special", + "on_order": 1, + "in_stock": 2 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123, + "on_order": 42, + "in_stock": 144 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17, + "extra": "special", + "on_order": 2, + "in_stock": 14 + } + ] + }, + "cost": 425, + "cost": 455, + "mode": "mode", + "mode_octal": "octal", + "links": "links", + "user": "user", + "group": "group", + "pre": "that", + "links": 3, + "post": "this", + "mode": "/some/file", + "mode_octal": 640, + "links": 1, + "user": "user", + "group": "group" + } +} diff --git a/contrib/libxo/tests/core/saved/test_01.T.err b/contrib/libxo/tests/core/saved/test_01.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.T.err diff --git a/contrib/libxo/tests/core/saved/test_01.T.out b/contrib/libxo/tests/core/saved/test_01.T.out new file mode 100644 index 000000000000..89d3157336e2 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.T.out @@ -0,0 +1,67 @@ +static ethernet bridge 18u 24anchor 0x0..1 +anchor 0x0..1 +anchor 0x0..1 +df 12% +testing argument modifier my-box.example.com... +testing argument modifier with encoding to .example.com... +Label text value +My Title + very 4242 +gum-1412Connecting to my-box.example.com... +Item Total Sold In Stock On Order SKU +gum 1412 54 10 GRO-000-415 +rope 85 4 2 HRD-000-212 +ladder 0 2 1 HRD-000-517 +bolt 4123 144 42 HRD-000-632 +water 17 14 2 GRO-000-2331 + + +Item 'gum': + Total sold: 1412.0 + In stock: 54 + On order: 10 + SKU: GRO-000-415 +Item 'rope': + Total sold: 85.0 + In stock: 4 + On order: 2 + SKU: HRD-000-212 +Item 'ladder': + Total sold: 0 + In stock: 2 + On order: 1 + SKU: HRD-000-517 +Item 'bolt': + Total sold: 4123.0 + In stock: 144 + On order: 42 + SKU: HRD-000-632 +Item 'water': + Total sold: 17.0 + In stock: 14 + On order: 2 + SKU: GRO-000-2331 +Item 'fish': + Total sold: 1321.0 + In stock: 45 + On order: 1 + SKU: GRO-000-533 +Item: gum +Item: rope +Item: ladder +Item: bolt +Item: water +Item Total Sold In Stock On Order SKU +gum 1412 10 54 GRO-000-415 +rope 85Extra: special 2 4 HRD-000-212 +ladder 0Extra: special 1 2 HRD-000-517 +bolt 4123 42 144 HRD-000-632 +water 17Extra: special 2 14 GRO-000-2331 + + +XXXXXXXX +X XCost: 425 +X XCost: 455 + links user group +3 this +/some/file 1 user group diff --git a/contrib/libxo/tests/core/saved/test_01.X.err b/contrib/libxo/tests/core/saved/test_01.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.X.err diff --git a/contrib/libxo/tests/core/saved/test_01.X.out b/contrib/libxo/tests/core/saved/test_01.X.out new file mode 100644 index 000000000000..2f1fa8261702 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.X.out @@ -0,0 +1 @@ +<top-level><type>ethernet</type><type>bridge</type><type>18u</type><type>24</type><address>0x0</address><port>1</port><address>0x0</address><port>1</port><address>0x0</address><port>1</port><used-percent>12</used-percent><kve_start>0xdeadbeef</kve_start><kve_end>0xcabb1e</kve_end><host>my-box</host><domain>example.com</domain><host>my-box</host><domain>example.com</domain><label>value</label><max-chaos>very</max-chaos><min-chaos>42</min-chaos><some-chaos>[42]</some-chaos><sku test-attr="attr-value">gum-000-1412</sku><host>my-box</host><domain>example.com</domain><data test="value"><item test2="value2"><sku test3="value3" key="key">GRO-000-415</sku><name key="key">gum</name><sold>1412</sold><in-stock>54</in-stock><on-order>10</on-order></item><item><sku test3="value3" key="key">HRD-000-212</sku><name key="key">rope</name><sold>85</sold><in-stock>4</in-stock><on-order>2</on-order></item><item><sku test3="value3" key="key">HRD-000-517</sku><name key="key">ladder</name><sold>0</sold><in-stock>2</in-stock><on-order>1</on-order></item><item><sku test3="value3" key="key">HRD-000-632</sku><name key="key">bolt</name><sold>4123</sold><in-stock>144</in-stock><on-order>42</on-order></item><item><sku test3="value3" key="key">GRO-000-2331</sku><name key="key">water</name><sold>17</sold><in-stock>14</in-stock><on-order>2</on-order></item></data><data2><item><sku key="key">GRO-000-415</sku><name key="key">gum</name><sold>1412.0</sold><in-stock>54</in-stock><on-order>10</on-order></item><item><sku key="key">HRD-000-212</sku><name key="key">rope</name><sold>85.0</sold><in-stock>4</in-stock><on-order>2</on-order></item><item><sku key="key">HRD-000-517</sku><name key="key">ladder</name><sold>0</sold><in-stock>2</in-stock><on-order>1</on-order></item><item><sku key="key">HRD-000-632</sku><name key="key">bolt</name><sold>4123.0</sold><in-stock>144</in-stock><on-order>42</on-order></item><item><sku key="key">GRO-000-2331</sku><name key="key">water</name><sold>17.0</sold><in-stock>14</in-stock><on-order>2</on-order></item></data2><data3><item><sku key="key">GRO-000-533</sku><name key="key">fish</name><sold>1321.0</sold><in-stock>45</in-stock><on-order>1</on-order></item></data3><data4><item test4="value4">gum</item><item test4="value4">rope</item><item test4="value4">ladder</item><item test4="value4">bolt</item><item test4="value4">water</item></data4><data test="value"><item test2="value2"><sku test3="value3" key="key">GRO-000-415</sku><name key="key">gum</name><sold>1412</sold><on-order>10</on-order><in-stock>54</in-stock></item><item><sku test3="value3" key="key">HRD-000-212</sku><name key="key">rope</name><sold>85</sold><extra>special</extra><on-order>2</on-order><in-stock>4</in-stock></item><item><sku test3="value3" key="key">HRD-000-517</sku><name key="key">ladder</name><sold>0</sold><extra>special</extra><on-order>1</on-order><in-stock>2</in-stock></item><item><sku test3="value3" key="key">HRD-000-632</sku><name key="key">bolt</name><sold>4123</sold><on-order>42</on-order><in-stock>144</in-stock></item><item><sku test3="value3" key="key">GRO-000-2331</sku><name key="key">water</name><sold>17</sold><extra>special</extra><on-order>2</on-order><in-stock>14</in-stock></item></data><cost>425</cost><cost>455</cost><mode>mode</mode><mode_octal>octal</mode_octal><links>links</links><user>user</user><group>group</group><pre>that</pre><links>3</links><post>this</post><mode>/some/file</mode><mode_octal>640</mode_octal><links>1</links><user>user</user><group>group</group></top-level>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_01.XP.err b/contrib/libxo/tests/core/saved/test_01.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.XP.err diff --git a/contrib/libxo/tests/core/saved/test_01.XP.out b/contrib/libxo/tests/core/saved/test_01.XP.out new file mode 100644 index 000000000000..afa79ada5f81 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.XP.out @@ -0,0 +1,171 @@ +<top-level> + <type>ethernet</type> + <type>bridge</type> + <type>18u</type> + <type>24</type> + <address>0x0</address> + <port>1</port> + <address>0x0</address> + <port>1</port> + <address>0x0</address> + <port>1</port> + <used-percent>12</used-percent> + <kve_start>0xdeadbeef</kve_start> + <kve_end>0xcabb1e</kve_end> + <host>my-box</host> + <domain>example.com</domain> + <host>my-box</host> + <domain>example.com</domain> + <label>value</label> + <max-chaos>very</max-chaos> + <min-chaos>42</min-chaos> + <some-chaos>[42]</some-chaos> + <sku test-attr="attr-value">gum-000-1412</sku> + <host>my-box</host> + <domain>example.com</domain> + <data test="value"> + <item test2="value2"> + <sku test3="value3" key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-632</sku> + <name key="key">bolt</name> + <sold>4123</sold> + <in-stock>144</in-stock> + <on-order>42</on-order> + </item> + <item> + <sku test3="value3" key="key">GRO-000-2331</sku> + <name key="key">water</name> + <sold>17</sold> + <in-stock>14</in-stock> + <on-order>2</on-order> + </item> + </data> + <data2> + <item> + <sku key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412.0</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + </item> + <item> + <sku key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85.0</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + </item> + <item> + <sku key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + </item> + <item> + <sku key="key">HRD-000-632</sku> + <name key="key">bolt</name> + <sold>4123.0</sold> + <in-stock>144</in-stock> + <on-order>42</on-order> + </item> + <item> + <sku key="key">GRO-000-2331</sku> + <name key="key">water</name> + <sold>17.0</sold> + <in-stock>14</in-stock> + <on-order>2</on-order> + </item> + </data2> + <data3> + <item> + <sku key="key">GRO-000-533</sku> + <name key="key">fish</name> + <sold>1321.0</sold> + <in-stock>45</in-stock> + <on-order>1</on-order> + </item> + </data3> + <data4> + <item test4="value4">gum</item> + <item test4="value4">rope</item> + <item test4="value4">ladder</item> + <item test4="value4">bolt</item> + <item test4="value4">water</item> + </data4> + <data test="value"> + <item test2="value2"> + <sku test3="value3" key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412</sold> + <on-order>10</on-order> + <in-stock>54</in-stock> + </item> + <item> + <sku test3="value3" key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85</sold> + <extra>special</extra> + <on-order>2</on-order> + <in-stock>4</in-stock> + </item> + <item> + <sku test3="value3" key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <extra>special</extra> + <on-order>1</on-order> + <in-stock>2</in-stock> + </item> + <item> + <sku test3="value3" key="key">HRD-000-632</sku> + <name key="key">bolt</name> + <sold>4123</sold> + <on-order>42</on-order> + <in-stock>144</in-stock> + </item> + <item> + <sku test3="value3" key="key">GRO-000-2331</sku> + <name key="key">water</name> + <sold>17</sold> + <extra>special</extra> + <on-order>2</on-order> + <in-stock>14</in-stock> + </item> + </data> + <cost>425</cost> + <cost>455</cost> + <mode>mode</mode> + <mode_octal>octal</mode_octal> + <links>links</links> + <user>user</user> + <group>group</group> + <pre>that</pre> + <links>3</links> + <post>this</post> + <mode>/some/file</mode> + <mode_octal>640</mode_octal> + <links>1</links> + <user>user</user> + <group>group</group> +</top-level> diff --git a/contrib/libxo/tests/core/saved/test_01.err b/contrib/libxo/tests/core/saved/test_01.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.err diff --git a/contrib/libxo/tests/core/saved/test_01.out b/contrib/libxo/tests/core/saved/test_01.out new file mode 100644 index 000000000000..c2ad7a005274 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_01.out @@ -0,0 +1,38 @@ +Item Total Sold In Stock On Order SKU +gum 1412 54 10 GRO-000-415 +rope 85 4 2 HRD-000-212 +ladder 0 2 1 HRD-000-517 +bolt 4123 144 42 HRD-000-632 +water 17 14 2 GRO-000-2331 + + +Item 'gum': + Total sold: 1412.0 + In stock: 54 + On order: 10 + SKU: GRO-000-415 +Item 'rope': + Total sold: 85.0 + In stock: 4 + On order: 2 + SKU: HRD-000-212 +Item 'ladder': + Total sold: 0 + In stock: 2 + On order: 1 + SKU: HRD-000-517 +Item 'bolt': + Total sold: 4123.0 + In stock: 144 + On order: 42 + SKU: HRD-000-632 +Item 'water': + Total sold: 17.0 + In stock: 14 + On order: 2 + SKU: GRO-000-2331 +Item 'fish': + Total sold: 1321.0 + In stock: 45 + On order: 1 + SKU: GRO-000-533 diff --git a/contrib/libxo/tests/core/saved/test_02.E.err b/contrib/libxo/tests/core/saved/test_02.E.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.E.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.E.out b/contrib/libxo/tests/core/saved/test_02.E.out new file mode 100644 index 000000000000..7550b680d09d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.E.out @@ -0,0 +1,73 @@ +op create: [test] [] [0] +op open_container: [top] [] [0x40010] +op open_container: [data] [] [0x40010] +op string: [name] [em0] [0x1080] +op string: [flags] [0x8843] [0x18] +op string: [name] [em0] [0x1088] +op string: [flags] [0x8843] [0x18] +op string: [what] [braces] [0] +op string: [length] [abcdef] [0] +op content: [fd] [-1] [0] +op string: [error] [Bad file descriptor] [0] +op string: [test] [good] [0] +op content: [fd] [-1] [0] +op string: [error] [Bad fi] [0] +op string: [test] [good] [0] +op content: [lines] [20] [0] +op content: [words] [30] [0] +op content: [characters] [40] [0] +op open_leaf_list: [bytes] [] [0] +op content: [bytes] [0] [0x2004] +op content: [bytes] [1] [0x2004] +op content: [bytes] [2] [0x2004] +op content: [bytes] [3] [0x2004] +op content: [bytes] [4] [0x2004] +op close_leaf_list: [bytes] [] [0] +op content: [granularity-lw] [155] [0] +op content: [mbuf-current] [10] [0] +op content: [mbuf-cache] [20] [0] +op content: [mbuf-total] [30] [0] +op content: [distance] [50] [0] +op string: [location] [Boston] [0] +op content: [memory] [64] [0] +op content: [total] [640] [0] +op content: [memory] [64] [0] +op content: [total] [640] [0] +op content: [ten] [10] [0] +op content: [eleven] [11] [0] +op content: [unknown] [1010] [0] +op content: [unknown] [1010] [0] +op content: [min] [15] [0x20] +op content: [cur] [20] [0x20] +op content: [max] [125] [0] +op content: [min] [15] [0] +op content: [cur] [20] [0] +op content: [max] [125] [0] +op content: [min] [15] [0x20] +op content: [cur] [20] [0x20] +op content: [max] [125] [0x20] +op content: [min] [15] [0] +op content: [cur] [20] [0] +op content: [max] [125] [0] +op content: [val1] [21] [0x8000] +op content: [val2] [58368] [0x18000] +op content: [val3] [100663296] [0x28000] +op content: [val4] [44470272] [0x48000] +op content: [val5] [1342172800] [0x28000] +op open_list: [flag] [] [0] +op string: [flag] [one] [0x2010] +op string: [flag] [two] [0x2010] +op string: [flag] [three] [0x2010] +op close_list: [flag] [] [0] +op content: [works] [null] [0x20] +op content: [empty-tag] [true] [0x8] +op string: [t1] [1000] [0x1010] +op string: [t2] [test5000] [0x1010] +op string: [t3] [ten-longx] [0x1010] +op string: [t4] [xtest] [0x1010] +op content: [count] [10] [0] +op content: [test] [4] [0] +op close_container: [data] [] [0] +op close_container: [top] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_02.H.err b/contrib/libxo/tests/core/saved/test_02.H.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.H.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.H.out b/contrib/libxo/tests/core/saved/test_02.H.out new file mode 100644 index 000000000000..03daf89ff0d2 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.H.out @@ -0,0 +1,10 @@ +<div class="line"><div class="data" data-tag="name">em0 </div><div class="data">em0 </div><div class="text">We are </div><div class="text">{emit}</div><div class="text">{ting}</div><div class="text"> some </div><div class="data" data-tag="what">braces</div></div><div class="line"><div class="message">abcdef +</div></div><div class="line"><div class="message">abcdef: Bad file descriptor +</div></div><div class="line"><div class="message">improper use of profanity; ten yard penalty; first down +</div></div><div class="line"><div class="text">length </div><div class="data" data-tag="length">abcdef</div></div><div class="line"><div class="text">close </div><div class="data" data-tag="fd">-1</div><div class="text"> returned </div><div class="data" data-tag="error">Bad file descriptor</div><div class="text"> </div><div class="data" data-tag="test">good</div></div><div class="line"><div class="text">close </div><div class="data" data-tag="fd">-1</div><div class="text"> returned </div><div class="data" data-tag="error">Bad fi</div><div class="text"> </div><div class="data" data-tag="test">good</div></div><div class="line"><div class="message">improper use of profanity; ten yard penalty; first down +</div></div><div class="line"><div class="text"> </div><div class="data" data-tag="lines"> 20</div><div class="text"> </div><div class="data" data-tag="words"> 30</div><div class="text"> </div><div class="data" data-tag="characters"> 40</div><div class="text"> </div><div class="data" data-tag="filename">file</div></div><div class="line"><div class="data" data-tag="bytes">0</div><div class="padding"> </div><div class="note">bytes</div></div><div class="line"><div class="data" data-tag="bytes">1</div><div class="padding"> </div><div class="note">byte</div></div><div class="line"><div class="data" data-tag="bytes">2</div><div class="padding"> </div><div class="note">bytes</div></div><div class="line"><div class="data" data-tag="bytes">3</div><div class="padding"> </div><div class="note">bytes</div></div><div class="line"><div class="data" data-tag="bytes">4</div><div class="padding"> </div><div class="note">bytes</div></div><div class="line"><div class="label">Low/warn granularity</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="granularity-lw" data-units="mAh">155</div><div class="padding"> </div></div><div class="line"><div class="data" data-tag="mbuf-current">10</div><div class="text">/</div><div class="data" data-tag="mbuf-cache">20</div><div class="text">/</div><div class="data" data-tag="mbuf-total">30</div><div class="text"> </div><div class="note">mbufs <&> in use (current/cache/total)</div></div><div class="line"><div class="data" data-tag="distance" data-units="miles">50</div><div class="padding"> </div><div class="text"> from </div><div class="data" data-tag="location">Boston</div></div><div class="line"><div class="data" data-tag="memory" data-units="k">64</div><div class="text"> left out of </div><div class="data" data-tag="total" data-units="kb">640</div></div><div class="line"><div class="data" data-tag="memory" data-units="k">64</div><div class="text"> left out of </div><div class="data" data-tag="total" data-units="kilobytes">640</div></div><div class="line"><div class="title">beforeworkingafter:</div></div><div class="line"><div class="data" data-tag="some">string</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="ten">10</div><div class="data" data-tag="eleven">11</div></div><div class="line"><div class="data" data-tag="unknown">1010</div><div class="text"> </div><div class="note">packets here/there/everywhere</div></div><div class="line"><div class="data" data-tag="unknown">1010</div><div class="text"> </div><div class="note">packets here/there/everywhere</div></div><div class="line"><div class="text">(</div><div class="padding"> </div><div class="data" data-tag="min">15</div><div class="text">/</div><div class="data" data-tag="cur">20</div><div class="text">/</div><div class="data" data-tag="max">125</div><div class="text">)</div></div><div class="line"><div class="text">(</div><div class="padding"> </div><div class="data" data-tag="min">15</div><div class="text">/</div><div class="data" data-tag="cur">20</div><div class="text">/</div><div class="data" data-tag="max">125</div><div class="text">)</div></div><div class="line"><div class="text">(</div><div class="data" data-tag="min">15</div><div class="text">/</div><div class="data" data-tag="cur">20</div><div class="text">/</div><div class="data" data-tag="max">125</div><div class="padding"> </div><div class="text">)</div></div><div class="line"><div class="text">(</div><div class="data" data-tag="min">15</div><div class="text">/</div><div class="data" data-tag="cur">20</div><div class="text">/</div><div class="data" data-tag="max">125</div><div class="padding"> </div><div class="text">)</div></div><div class="line"><div class="text">Humanize: </div><div class="data" data-tag="val1" data-number="21">21</div><div class="text">, </div><div class="data" data-tag="val2" data-number="58368">57 K</div><div class="text">, </div><div class="data" data-tag="val3" data-number="100663296">96M</div><div class="text">, </div><div class="data" data-tag="val4" data-number="44470272">44M</div><div class="text">, </div><div class="data" data-tag="val5" data-number="1342172800">1.2G</div></div><div class="line"><div class="data" data-tag="flag">one</div><div class="text"> </div><div class="data" data-tag="flag">two</div><div class="text"> </div><div class="data" data-tag="flag">three</div></div><div class="line"><div class="data" data-tag="works">(null)</div></div><div class="line"><div class="text">1:</div><div class="data" data-tag="t1"> 1000</div><div class="text"> 2:</div><div class="data" data-tag="t2">test5000 </div><div class="text"> 3:</div><div class="data" data-tag="t3"> ten-longx</div><div class="text"> 4:</div><div class="data" data-tag="t4">xtest </div></div><div class="line"><div class="error">this is an error</div></div><div class="line"><div class="error">two more errors</div></div><div class="line"><div class="warning">this is an warning</div></div><div class="line"><div class="warning">two more warnings</div></div><div class="line"><div class="label">V1/V2 packets</div><div class="text">: </div><div class="data" data-tag="count">10</div></div><div class="line"><div class="data" data-tag="test">0004</div><div class="text"> </div><div class="label">tries</div></div><div class="line"><div class="message">improper use of profanity; ten yard penalty; first down +</div></div><div class="line"><div class="error">Shut 'er down, Clancey! She's a-pumpin' mud! <>!,"!<> +</div></div><div class="line"><div class="error">err message (1)</div></div><div class="line"><div class="error">err message (2) +</div></div><div class="line"><div class="error">err message (1) +</div></div><div class="line"><div class="error">err message (2) +</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_02.HIPx.err b/contrib/libxo/tests/core/saved/test_02.HIPx.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.HIPx.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.HIPx.out b/contrib/libxo/tests/core/saved/test_02.HIPx.out new file mode 100644 index 000000000000..6859660f2f09 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.HIPx.out @@ -0,0 +1,249 @@ +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/name">em0 </div> + <div class="data">em0 </div> + <div class="text">We are </div> + <div class="text">{emit}</div> + <div class="text">{ting}</div> + <div class="text"> some </div> + <div class="data" data-tag="what" data-xpath="/top/data[name = 'em0 '][name = 'em0']/what">braces</div> +</div> +<div class="line"> + <div class="message">abcdef +</div> +</div> +<div class="line"> + <div class="message">abcdef: Bad file descriptor +</div> +</div> +<div class="line"> + <div class="message">improper use of profanity; ten yard penalty; first down +</div> +</div> +<div class="line"> + <div class="text">length </div> + <div class="data" data-tag="length" data-xpath="/top/data[name = 'em0 '][name = 'em0']/length">abcdef</div> +</div> +<div class="line"> + <div class="text">close </div> + <div class="data" data-tag="fd" data-xpath="/top/data[name = 'em0 '][name = 'em0']/fd">-1</div> + <div class="text"> returned </div> + <div class="data" data-tag="error" data-xpath="/top/data[name = 'em0 '][name = 'em0']/error">Bad file descriptor</div> + <div class="text"> </div> + <div class="data" data-tag="test" data-xpath="/top/data[name = 'em0 '][name = 'em0']/test">good</div> +</div> +<div class="line"> + <div class="text">close </div> + <div class="data" data-tag="fd" data-xpath="/top/data[name = 'em0 '][name = 'em0']/fd">-1</div> + <div class="text"> returned </div> + <div class="data" data-tag="error" data-xpath="/top/data[name = 'em0 '][name = 'em0']/error">Bad fi</div> + <div class="text"> </div> + <div class="data" data-tag="test" data-xpath="/top/data[name = 'em0 '][name = 'em0']/test">good</div> +</div> +<div class="line"> + <div class="message">improper use of profanity; ten yard penalty; first down +</div> +</div> +<div class="line"> + <div class="text"> </div> + <div class="data" data-tag="lines" data-xpath="/top/data[name = 'em0 '][name = 'em0']/lines"> 20</div> + <div class="text"> </div> + <div class="data" data-tag="words" data-xpath="/top/data[name = 'em0 '][name = 'em0']/words"> 30</div> + <div class="text"> </div> + <div class="data" data-tag="characters" data-xpath="/top/data[name = 'em0 '][name = 'em0']/characters"> 40</div> + <div class="text"> </div> + <div class="data" data-tag="filename" data-xpath="/top/data[name = 'em0 '][name = 'em0']/filename">file</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/data[name = 'em0 '][name = 'em0']/bytes">0</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/data[name = 'em0 '][name = 'em0']/bytes">1</div> + <div class="padding"> </div> + <div class="note">byte</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/data[name = 'em0 '][name = 'em0']/bytes">2</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/data[name = 'em0 '][name = 'em0']/bytes">3</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/data[name = 'em0 '][name = 'em0']/bytes">4</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="label">Low/warn granularity</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="granularity-lw" data-units="mAh" data-xpath="/top/data[name = 'em0 '][name = 'em0']/granularity-lw">155</div> + <div class="padding"> </div> +</div> +<div class="line"> + <div class="data" data-tag="mbuf-current" data-xpath="/top/data[name = 'em0 '][name = 'em0']/mbuf-current">10</div> + <div class="text">/</div> + <div class="data" data-tag="mbuf-cache" data-xpath="/top/data[name = 'em0 '][name = 'em0']/mbuf-cache">20</div> + <div class="text">/</div> + <div class="data" data-tag="mbuf-total" data-xpath="/top/data[name = 'em0 '][name = 'em0']/mbuf-total">30</div> + <div class="text"> </div> + <div class="note">mbufs <&> in use (current/cache/total)</div> +</div> +<div class="line"> + <div class="data" data-tag="distance" data-units="miles" data-xpath="/top/data[name = 'em0 '][name = 'em0']/distance">50</div> + <div class="padding"> </div> + <div class="text"> from </div> + <div class="data" data-tag="location" data-xpath="/top/data[name = 'em0 '][name = 'em0']/location">Boston</div> +</div> +<div class="line"> + <div class="data" data-tag="memory" data-units="k" data-xpath="/top/data[name = 'em0 '][name = 'em0']/memory">64</div> + <div class="text"> left out of </div> + <div class="data" data-tag="total" data-units="kb" data-xpath="/top/data[name = 'em0 '][name = 'em0']/total">640</div> +</div> +<div class="line"> + <div class="data" data-tag="memory" data-units="k" data-xpath="/top/data[name = 'em0 '][name = 'em0']/memory">64</div> + <div class="text"> left out of </div> + <div class="data" data-tag="total" data-units="kilobytes" data-xpath="/top/data[name = 'em0 '][name = 'em0']/total">640</div> +</div> +<div class="line"> + <div class="title">beforeworkingafter:</div> +</div> +<div class="line"> + <div class="data" data-tag="some" data-xpath="/top/data[name = 'em0 '][name = 'em0']/some">string</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="ten" data-xpath="/top/data[name = 'em0 '][name = 'em0']/ten">10</div> + <div class="data" data-tag="eleven" data-xpath="/top/data[name = 'em0 '][name = 'em0']/eleven">11</div> +</div> +<div class="line"> + <div class="data" data-tag="unknown" data-xpath="/top/data[name = 'em0 '][name = 'em0']/unknown">1010</div> + <div class="text"> </div> + <div class="note">packets here/there/everywhere</div> +</div> +<div class="line"> + <div class="data" data-tag="unknown" data-xpath="/top/data[name = 'em0 '][name = 'em0']/unknown">1010</div> + <div class="text"> </div> + <div class="note">packets here/there/everywhere</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="padding"> </div> + <div class="data" data-tag="min" data-xpath="/top/data[name = 'em0 '][name = 'em0']/min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur" data-xpath="/top/data[name = 'em0 '][name = 'em0']/cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max" data-xpath="/top/data[name = 'em0 '][name = 'em0']/max">125</div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="padding"> </div> + <div class="data" data-tag="min" data-xpath="/top/data[name = 'em0 '][name = 'em0']/min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur" data-xpath="/top/data[name = 'em0 '][name = 'em0']/cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max" data-xpath="/top/data[name = 'em0 '][name = 'em0']/max">125</div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="data" data-tag="min" data-xpath="/top/data[name = 'em0 '][name = 'em0']/min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur" data-xpath="/top/data[name = 'em0 '][name = 'em0']/cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max" data-xpath="/top/data[name = 'em0 '][name = 'em0']/max">125</div> + <div class="padding"> </div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="data" data-tag="min" data-xpath="/top/data[name = 'em0 '][name = 'em0']/min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur" data-xpath="/top/data[name = 'em0 '][name = 'em0']/cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max" data-xpath="/top/data[name = 'em0 '][name = 'em0']/max">125</div> + <div class="padding"> </div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">Humanize: </div> + <div class="data" data-tag="val1" data-xpath="/top/data[name = 'em0 '][name = 'em0']/val1" data-number="21">21</div> + <div class="text">, </div> + <div class="data" data-tag="val2" data-xpath="/top/data[name = 'em0 '][name = 'em0']/val2" data-number="58368">57 K</div> + <div class="text">, </div> + <div class="data" data-tag="val3" data-xpath="/top/data[name = 'em0 '][name = 'em0']/val3" data-number="100663296">96M</div> + <div class="text">, </div> + <div class="data" data-tag="val4" data-xpath="/top/data[name = 'em0 '][name = 'em0']/val4" data-number="44470272">44M</div> + <div class="text">, </div> + <div class="data" data-tag="val5" data-xpath="/top/data[name = 'em0 '][name = 'em0']/val5" data-number="1342172800">1.2G</div> +</div> +<div class="line"> + <div class="data" data-tag="flag" data-xpath="/top/data[name = 'em0 '][name = 'em0']/flag">one</div> + <div class="text"> </div> + <div class="data" data-tag="flag" data-xpath="/top/data[name = 'em0 '][name = 'em0']/flag">two</div> + <div class="text"> </div> + <div class="data" data-tag="flag" data-xpath="/top/data[name = 'em0 '][name = 'em0']/flag">three</div> +</div> +<div class="line"> + <div class="data" data-tag="works" data-xpath="/top/data[name = 'em0 '][name = 'em0']/works">(null)</div> +</div> +<div class="line"> + <div class="text">1:</div> + <div class="data" data-tag="t1" data-xpath="/top/data[name = 'em0 '][name = 'em0']/t1"> 1000</div> + <div class="text"> 2:</div> + <div class="data" data-tag="t2" data-xpath="/top/data[name = 'em0 '][name = 'em0']/t2">test5000 </div> + <div class="text"> 3:</div> + <div class="data" data-tag="t3" data-xpath="/top/data[name = 'em0 '][name = 'em0']/t3"> ten-longx</div> + <div class="text"> 4:</div> + <div class="data" data-tag="t4" data-xpath="/top/data[name = 'em0 '][name = 'em0']/t4">xtest </div> +</div> +<div class="line"> + <div class="error">this is an error</div> +</div> +<div class="line"> + <div class="error">two more errors</div> +</div> +<div class="line"> + <div class="warning">this is an warning</div> +</div> +<div class="line"> + <div class="warning">two more warnings</div> +</div> +<div class="line"> + <div class="label">V1/V2 packets</div> + <div class="text">: </div> + <div class="data" data-tag="count" data-xpath="/top/data[name = 'em0 '][name = 'em0']/count">10</div> +</div> +<div class="line"> + <div class="data" data-tag="test" data-xpath="/top/data[name = 'em0 '][name = 'em0']/test">0004</div> + <div class="text"> </div> + <div class="label">tries</div> +</div> +<div class="line"> + <div class="message">improper use of profanity; ten yard penalty; first down +</div> +</div> +<div class="line"> + <div class="error">Shut 'er down, Clancey! She's a-pumpin' mud! <>!,"!<> +</div> +</div> +<div class="line"> + <div class="error">err message (1)</div> +</div> +<div class="line"> + <div class="error">err message (2) +</div> +</div> +<div class="line"> + <div class="error">err message (1) +</div> +</div> +<div class="line"> + <div class="error">err message (2) +</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_02.HP.err b/contrib/libxo/tests/core/saved/test_02.HP.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.HP.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.HP.out b/contrib/libxo/tests/core/saved/test_02.HP.out new file mode 100644 index 000000000000..6bf93277a3b8 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.HP.out @@ -0,0 +1,249 @@ +<div class="line"> + <div class="data" data-tag="name">em0 </div> + <div class="data">em0 </div> + <div class="text">We are </div> + <div class="text">{emit}</div> + <div class="text">{ting}</div> + <div class="text"> some </div> + <div class="data" data-tag="what">braces</div> +</div> +<div class="line"> + <div class="message">abcdef +</div> +</div> +<div class="line"> + <div class="message">abcdef: Bad file descriptor +</div> +</div> +<div class="line"> + <div class="message">improper use of profanity; ten yard penalty; first down +</div> +</div> +<div class="line"> + <div class="text">length </div> + <div class="data" data-tag="length">abcdef</div> +</div> +<div class="line"> + <div class="text">close </div> + <div class="data" data-tag="fd">-1</div> + <div class="text"> returned </div> + <div class="data" data-tag="error">Bad file descriptor</div> + <div class="text"> </div> + <div class="data" data-tag="test">good</div> +</div> +<div class="line"> + <div class="text">close </div> + <div class="data" data-tag="fd">-1</div> + <div class="text"> returned </div> + <div class="data" data-tag="error">Bad fi</div> + <div class="text"> </div> + <div class="data" data-tag="test">good</div> +</div> +<div class="line"> + <div class="message">improper use of profanity; ten yard penalty; first down +</div> +</div> +<div class="line"> + <div class="text"> </div> + <div class="data" data-tag="lines"> 20</div> + <div class="text"> </div> + <div class="data" data-tag="words"> 30</div> + <div class="text"> </div> + <div class="data" data-tag="characters"> 40</div> + <div class="text"> </div> + <div class="data" data-tag="filename">file</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">0</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">1</div> + <div class="padding"> </div> + <div class="note">byte</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">2</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">3</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">4</div> + <div class="padding"> </div> + <div class="note">bytes</div> +</div> +<div class="line"> + <div class="label">Low/warn granularity</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="granularity-lw" data-units="mAh">155</div> + <div class="padding"> </div> +</div> +<div class="line"> + <div class="data" data-tag="mbuf-current">10</div> + <div class="text">/</div> + <div class="data" data-tag="mbuf-cache">20</div> + <div class="text">/</div> + <div class="data" data-tag="mbuf-total">30</div> + <div class="text"> </div> + <div class="note">mbufs <&> in use (current/cache/total)</div> +</div> +<div class="line"> + <div class="data" data-tag="distance" data-units="miles">50</div> + <div class="padding"> </div> + <div class="text"> from </div> + <div class="data" data-tag="location">Boston</div> +</div> +<div class="line"> + <div class="data" data-tag="memory" data-units="k">64</div> + <div class="text"> left out of </div> + <div class="data" data-tag="total" data-units="kb">640</div> +</div> +<div class="line"> + <div class="data" data-tag="memory" data-units="k">64</div> + <div class="text"> left out of </div> + <div class="data" data-tag="total" data-units="kilobytes">640</div> +</div> +<div class="line"> + <div class="title">beforeworkingafter:</div> +</div> +<div class="line"> + <div class="data" data-tag="some">string</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="ten">10</div> + <div class="data" data-tag="eleven">11</div> +</div> +<div class="line"> + <div class="data" data-tag="unknown">1010</div> + <div class="text"> </div> + <div class="note">packets here/there/everywhere</div> +</div> +<div class="line"> + <div class="data" data-tag="unknown">1010</div> + <div class="text"> </div> + <div class="note">packets here/there/everywhere</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="padding"> </div> + <div class="data" data-tag="min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max">125</div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="padding"> </div> + <div class="data" data-tag="min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max">125</div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="data" data-tag="min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max">125</div> + <div class="padding"> </div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">(</div> + <div class="data" data-tag="min">15</div> + <div class="text">/</div> + <div class="data" data-tag="cur">20</div> + <div class="text">/</div> + <div class="data" data-tag="max">125</div> + <div class="padding"> </div> + <div class="text">)</div> +</div> +<div class="line"> + <div class="text">Humanize: </div> + <div class="data" data-tag="val1" data-number="21">21</div> + <div class="text">, </div> + <div class="data" data-tag="val2" data-number="58368">57 K</div> + <div class="text">, </div> + <div class="data" data-tag="val3" data-number="100663296">96M</div> + <div class="text">, </div> + <div class="data" data-tag="val4" data-number="44470272">44M</div> + <div class="text">, </div> + <div class="data" data-tag="val5" data-number="1342172800">1.2G</div> +</div> +<div class="line"> + <div class="data" data-tag="flag">one</div> + <div class="text"> </div> + <div class="data" data-tag="flag">two</div> + <div class="text"> </div> + <div class="data" data-tag="flag">three</div> +</div> +<div class="line"> + <div class="data" data-tag="works">(null)</div> +</div> +<div class="line"> + <div class="text">1:</div> + <div class="data" data-tag="t1"> 1000</div> + <div class="text"> 2:</div> + <div class="data" data-tag="t2">test5000 </div> + <div class="text"> 3:</div> + <div class="data" data-tag="t3"> ten-longx</div> + <div class="text"> 4:</div> + <div class="data" data-tag="t4">xtest </div> +</div> +<div class="line"> + <div class="error">this is an error</div> +</div> +<div class="line"> + <div class="error">two more errors</div> +</div> +<div class="line"> + <div class="warning">this is an warning</div> +</div> +<div class="line"> + <div class="warning">two more warnings</div> +</div> +<div class="line"> + <div class="label">V1/V2 packets</div> + <div class="text">: </div> + <div class="data" data-tag="count">10</div> +</div> +<div class="line"> + <div class="data" data-tag="test">0004</div> + <div class="text"> </div> + <div class="label">tries</div> +</div> +<div class="line"> + <div class="message">improper use of profanity; ten yard penalty; first down +</div> +</div> +<div class="line"> + <div class="error">Shut 'er down, Clancey! She's a-pumpin' mud! <>!,"!<> +</div> +</div> +<div class="line"> + <div class="error">err message (1)</div> +</div> +<div class="line"> + <div class="error">err message (2) +</div> +</div> +<div class="line"> + <div class="error">err message (1) +</div> +</div> +<div class="line"> + <div class="error">err message (2) +</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_02.J.err b/contrib/libxo/tests/core/saved/test_02.J.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.J.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.J.out b/contrib/libxo/tests/core/saved/test_02.J.out new file mode 100644 index 000000000000..5e01fa9a8bd4 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.J.out @@ -0,0 +1 @@ +{"top": {"data": {"name":"em0","flags":"0x8843","name":"em0","flags":"0x8843","what":"braces","length":"abcdef","fd":-1,"error":"Bad file descriptor","test":"good","fd":-1,"error":"Bad fi","test":"good","lines":20,"words":30,"characters":40, "bytes": [0,1,2,3,4],"granularity-lw":155,"mbuf-current":10,"mbuf-cache":20,"mbuf-total":30,"distance":50,"location":"Boston","memory":64,"total":640,"memory":64,"total":640,"ten":10,"eleven":11,"unknown":1010,"unknown":1010,"min":15,"cur":20,"max":125,"min":15,"cur":20,"max":125,"min":15,"cur":20,"max":125,"min":15,"cur":20,"max":125,"val1":21,"val2":58368,"val3":100663296,"val4":44470272,"val5":1342172800, "flag": ["one","two","three"],"works":null,"empty-tag":true,"t1":"1000","t2":"test5000","t3":"ten-longx","t4":"xtest", "__error": {"message":"this is an error"}, "__error": {"message":"two more errors"}, "__warning": {"message":"this is an warning"}, "__warning": {"message":"two more warnings"},"count":10,"test":4, "error": {"message":"Shut 'er down, Clancey! She's a-pumpin' mud! <>!,\"!<>\n"}, "error": {"message":"err message (1)"}, "error": {"message":"err message (2)\n"}, "error": {"message":"err message (1)\n"}, "error": {"message":"err message (2)\n"}}}} diff --git a/contrib/libxo/tests/core/saved/test_02.JP.err b/contrib/libxo/tests/core/saved/test_02.JP.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.JP.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.JP.out b/contrib/libxo/tests/core/saved/test_02.JP.out new file mode 100644 index 000000000000..ef39233d0062 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.JP.out @@ -0,0 +1,99 @@ +{ + "top": { + "data": { + "name": "em0", + "flags": "0x8843", + "name": "em0", + "flags": "0x8843", + "what": "braces", + "length": "abcdef", + "fd": -1, + "error": "Bad file descriptor", + "test": "good", + "fd": -1, + "error": "Bad fi", + "test": "good", + "lines": 20, + "words": 30, + "characters": 40, + "bytes": [ + 0, + 1, + 2, + 3, + 4 + ], + "granularity-lw": 155, + "mbuf-current": 10, + "mbuf-cache": 20, + "mbuf-total": 30, + "distance": 50, + "location": "Boston", + "memory": 64, + "total": 640, + "memory": 64, + "total": 640, + "ten": 10, + "eleven": 11, + "unknown": 1010, + "unknown": 1010, + "min": 15, + "cur": 20, + "max": 125, + "min": 15, + "cur": 20, + "max": 125, + "min": 15, + "cur": 20, + "max": 125, + "min": 15, + "cur": 20, + "max": 125, + "val1": 21, + "val2": 58368, + "val3": 100663296, + "val4": 44470272, + "val5": 1342172800, + "flag": [ + "one", + "two", + "three" + ], + "works": null, + "empty-tag": true, + "t1": "1000", + "t2": "test5000", + "t3": "ten-longx", + "t4": "xtest", + "__error": { + "message": "this is an error" + }, + "__error": { + "message": "two more errors" + }, + "__warning": { + "message": "this is an warning" + }, + "__warning": { + "message": "two more warnings" + }, + "count": 10, + "test": 4, + "error": { + "message": "Shut 'er down, Clancey! She's a-pumpin' mud! <>!,\"!<>\n" + }, + "error": { + "message": "err message (1)" + }, + "error": { + "message": "err message (2)\n" + }, + "error": { + "message": "err message (1)\n" + }, + "error": { + "message": "err message (2)\n" + } + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_02.JPu.err b/contrib/libxo/tests/core/saved/test_02.JPu.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.JPu.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.JPu.out b/contrib/libxo/tests/core/saved/test_02.JPu.out new file mode 100644 index 000000000000..d0b868a5f8ee --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.JPu.out @@ -0,0 +1,99 @@ +{ + "top": { + "data": { + "name": "em0", + "flags": "0x8843", + "name": "em0", + "flags": "0x8843", + "what": "braces", + "length": "abcdef", + "fd": -1, + "error": "Bad file descriptor", + "test": "good", + "fd": -1, + "error": "Bad fi", + "test": "good", + "lines": 20, + "words": 30, + "characters": 40, + "bytes": [ + 0, + 1, + 2, + 3, + 4 + ], + "granularity_lw": 155, + "mbuf_current": 10, + "mbuf_cache": 20, + "mbuf_total": 30, + "distance": 50, + "location": "Boston", + "memory": 64, + "total": 640, + "memory": 64, + "total": 640, + "ten": 10, + "eleven": 11, + "unknown": 1010, + "unknown": 1010, + "min": 15, + "cur": 20, + "max": 125, + "min": 15, + "cur": 20, + "max": 125, + "min": 15, + "cur": 20, + "max": 125, + "min": 15, + "cur": 20, + "max": 125, + "val1": 21, + "val2": 58368, + "val3": 100663296, + "val4": 44470272, + "val5": 1342172800, + "flag": [ + "one", + "two", + "three" + ], + "works": null, + "empty_tag": true, + "t1": "1000", + "t2": "test5000", + "t3": "ten-longx", + "t4": "xtest", + "__error": { + "message": "this is an error" + }, + "__error": { + "message": "two more errors" + }, + "__warning": { + "message": "this is an warning" + }, + "__warning": { + "message": "two more warnings" + }, + "count": 10, + "test": 4, + "error": { + "message": "Shut 'er down, Clancey! She's a-pumpin' mud! <>!,\"!<>\n" + }, + "error": { + "message": "err message (1)" + }, + "error": { + "message": "err message (2)\n" + }, + "error": { + "message": "err message (1)\n" + }, + "error": { + "message": "err message (2)\n" + } + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_02.T.err b/contrib/libxo/tests/core/saved/test_02.T.err new file mode 100644 index 000000000000..debdac6a5157 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.T.err @@ -0,0 +1,5 @@ +test_02: key field emitted after normal value field: 'name' +Shut 'er down, Clancey! She's a-pumpin' mud! <>!,"!<> +err message (1)err message (2) +err message (1) +err message (2) diff --git a/contrib/libxo/tests/core/saved/test_02.T.out b/contrib/libxo/tests/core/saved/test_02.T.out new file mode 100644 index 000000000000..552e95393ab5 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.T.out @@ -0,0 +1,38 @@ +em0 em0 We are {emit}{ting} some braces +abcdef +abcdef: Bad file descriptor +improper use of profanity; ten yard penalty; first down +length abcdef +close -1 returned Bad file descriptor good +close -1 returned Bad fi good +improper use of profanity; ten yard penalty; first down + 20 30 40 file +0 bytes +1 byte +2 bytes +3 bytes +4 bytes +Low/warn granularity: 155 mAh +10/20/30 mbufs <&> in use (current/cache/total) +50 miles from Boston +64k left out of 640kb +64k left out of 640kilobytes +beforeworkingafter: +string: 1011 +1010 packets here/there/everywhere +1010 packets here/there/everywhere +( 15/20/125) +( 15/20/125) +(15/20/125 ) +(15/20/125 ) +Humanize: 21, 57 K, 96M, 44M, 1.2G +one two three +(null) +1: 1000 2:test5000 3: ten-longx 4:xtest +this is an error +two more errors +this is an warning +two more warnings +V1/V2 packets: 10 +0004 tries +improper use of profanity; ten yard penalty; first down diff --git a/contrib/libxo/tests/core/saved/test_02.X.err b/contrib/libxo/tests/core/saved/test_02.X.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.X.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.X.out b/contrib/libxo/tests/core/saved/test_02.X.out new file mode 100644 index 000000000000..3c491c3ec81b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.X.out @@ -0,0 +1,10 @@ +<top><data><name>em0</name><flags>0x8843</flags><name>em0</name><flags>0x8843</flags><what>braces</what><message>abcdef +</message><message>abcdef: Bad file descriptor +</message><message>improper use of profanity; ten yard penalty; first down +</message><length>abcdef</length><fd>-1</fd><error>Bad file descriptor</error><test>good</test><fd>-1</fd><error>Bad fi</error><test>good</test><message>improper use of profanity; ten yard penalty; first down +</message><lines>20</lines><words>30</words><characters>40</characters><bytes>0</bytes><bytes>1</bytes><bytes>2</bytes><bytes>3</bytes><bytes>4</bytes><granularity-lw units="mAh">155</granularity-lw><mbuf-current>10</mbuf-current><mbuf-cache>20</mbuf-cache><mbuf-total>30</mbuf-total><distance units="miles">50</distance><location>Boston</location><memory units="k">64</memory><total units="kb">640</total><memory units="k">64</memory><total units="kilobytes">640</total><ten>10</ten><eleven>11</eleven><unknown>1010</unknown><unknown>1010</unknown><min>15</min><cur>20</cur><max>125</max><min>15</min><cur>20</cur><max>125</max><min>15</min><cur>20</cur><max>125</max><min>15</min><cur>20</cur><max>125</max><val1>21</val1><val2>58368</val2><val3>100663296</val3><val4>44470272</val4><val5>1342172800</val5><flag>one</flag><flag>two</flag><flag>three</flag><works>null</works><empty-tag></empty-tag><t1>1000</t1><t2>test5000</t2><t3>ten-longx</t3><t4>xtest</t4><__error><message>this is an error</message></__error><__error><message>two more errors</message></__error><__warning><message>this is an warning</message></__warning><__warning><message>two more warnings</message></__warning><count>10</count><test>4</test><message>improper use of profanity; ten yard penalty; first down +</message><error><message>Shut 'er down, Clancey! She's a-pumpin' mud! <>!,"!<> +</message></error><error><message>err message (1)</message></error><error><message>err message (2) +</message></error><error><message>err message (1) +</message></error><error><message>err message (2) +</message></error></data></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_02.XP.err b/contrib/libxo/tests/core/saved/test_02.XP.err new file mode 100644 index 000000000000..cedb03e0da31 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.XP.err @@ -0,0 +1 @@ +test_02: key field emitted after normal value field: 'name' diff --git a/contrib/libxo/tests/core/saved/test_02.XP.out b/contrib/libxo/tests/core/saved/test_02.XP.out new file mode 100644 index 000000000000..c9e85cb46d5b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.XP.out @@ -0,0 +1,107 @@ +<top> + <data> + <name>em0</name> + <flags>0x8843</flags> + <name>em0</name> + <flags>0x8843</flags> + <what>braces</what> + <message>abcdef +</message> + <message>abcdef: Bad file descriptor +</message> + <message>improper use of profanity; ten yard penalty; first down +</message> + <length>abcdef</length> + <fd>-1</fd> + <error>Bad file descriptor</error> + <test>good</test> + <fd>-1</fd> + <error>Bad fi</error> + <test>good</test> + <message>improper use of profanity; ten yard penalty; first down +</message> + <lines>20</lines> + <words>30</words> + <characters>40</characters> + <bytes>0</bytes> + <bytes>1</bytes> + <bytes>2</bytes> + <bytes>3</bytes> + <bytes>4</bytes> + <granularity-lw units="mAh">155</granularity-lw> + <mbuf-current>10</mbuf-current> + <mbuf-cache>20</mbuf-cache> + <mbuf-total>30</mbuf-total> + <distance units="miles">50</distance> + <location>Boston</location> + <memory units="k">64</memory> + <total units="kb">640</total> + <memory units="k">64</memory> + <total units="kilobytes">640</total> + <ten>10</ten> + <eleven>11</eleven> + <unknown>1010</unknown> + <unknown>1010</unknown> + <min>15</min> + <cur>20</cur> + <max>125</max> + <min>15</min> + <cur>20</cur> + <max>125</max> + <min>15</min> + <cur>20</cur> + <max>125</max> + <min>15</min> + <cur>20</cur> + <max>125</max> + <val1>21</val1> + <val2>58368</val2> + <val3>100663296</val3> + <val4>44470272</val4> + <val5>1342172800</val5> + <flag>one</flag> + <flag>two</flag> + <flag>three</flag> + <works>null</works> + <empty-tag></empty-tag> + <t1>1000</t1> + <t2>test5000</t2> + <t3>ten-longx</t3> + <t4>xtest</t4> + <__error> + <message>this is an error</message> + </__error> + <__error> + <message>two more errors</message> + </__error> + <__warning> + <message>this is an warning</message> + </__warning> + <__warning> + <message>two more warnings</message> + </__warning> + <count>10</count> + <test>4</test> + <message>improper use of profanity; ten yard penalty; first down +</message> + <error> + <message>Shut 'er down, Clancey! She's a-pumpin' mud! <>!,"!<> +</message> + </error> + <error> + <message>err message (1)</message> + </error> + <error> + <message>err message (2) +</message> + </error> + <error> + <message>err message (1) +</message> + </error> + <error> + <message>err message (2) +</message> + </error> + </data> +</top> diff --git a/contrib/libxo/tests/core/saved/test_02.err b/contrib/libxo/tests/core/saved/test_02.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.err diff --git a/contrib/libxo/tests/core/saved/test_02.out b/contrib/libxo/tests/core/saved/test_02.out new file mode 100644 index 000000000000..c2ad7a005274 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_02.out @@ -0,0 +1,38 @@ +Item Total Sold In Stock On Order SKU +gum 1412 54 10 GRO-000-415 +rope 85 4 2 HRD-000-212 +ladder 0 2 1 HRD-000-517 +bolt 4123 144 42 HRD-000-632 +water 17 14 2 GRO-000-2331 + + +Item 'gum': + Total sold: 1412.0 + In stock: 54 + On order: 10 + SKU: GRO-000-415 +Item 'rope': + Total sold: 85.0 + In stock: 4 + On order: 2 + SKU: HRD-000-212 +Item 'ladder': + Total sold: 0 + In stock: 2 + On order: 1 + SKU: HRD-000-517 +Item 'bolt': + Total sold: 4123.0 + In stock: 144 + On order: 42 + SKU: HRD-000-632 +Item 'water': + Total sold: 17.0 + In stock: 14 + On order: 2 + SKU: GRO-000-2331 +Item 'fish': + Total sold: 1321.0 + In stock: 45 + On order: 1 + SKU: GRO-000-533 diff --git a/contrib/libxo/tests/core/saved/test_03.E.err b/contrib/libxo/tests/core/saved/test_03.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.E.err diff --git a/contrib/libxo/tests/core/saved/test_03.E.out b/contrib/libxo/tests/core/saved/test_03.E.out new file mode 100644 index 000000000000..7c27f2d4ed81 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.E.out @@ -0,0 +1,34 @@ +op create: [test] [] [0] +op open_container: [employees] [] [0x10] +op open_list: [employee] [] [0] +op close_list: [employee] [] [0] +op string: [extra] [] [0] +op open_list: [memory] [] [0] +op open_instance: [memory] [] [0x10] +op string: [type] [name] [0x80] +op content: [in-use] [12345] [0] +op content: [memory-use] [54321] [0] +op string: [high-use] [-] [0] +op content: [requests] [32145] [0] +op close_instance: [memory] [] [0] +op close_list: [memory] [] [0] +op open_list: [employee] [] [0] +op open_instance: [employee] [] [0x10] +op string: [first-name] [Terry] [0] +op string: [last-name] [Jones] [0] +op content: [department] [660] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x10] +op string: [first-name] [Leslie] [0] +op string: [last-name] [Patterson] [0] +op content: [department] [341] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x10] +op string: [first-name] [Ashley] [0] +op string: [last-name] [Smith] [0] +op content: [department] [1440] [0] +op close_instance: [employee] [] [0] +op close_list: [employee] [] [0] +op close_container: [employees] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_03.H.err b/contrib/libxo/tests/core/saved/test_03.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.H.err diff --git a/contrib/libxo/tests/core/saved/test_03.H.out b/contrib/libxo/tests/core/saved/test_03.H.out new file mode 100644 index 000000000000..ff618972a3ef --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.H.out @@ -0,0 +1 @@ +<div class="line"><div class="text">[</div><div class="data" data-tag="extra"></div><div class="text">]</div></div><div class="line"><div class="title"> Type</div><div class="text"> </div><div class="title">InUse</div><div class="text"> </div><div class="title">MemUse</div><div class="text"> </div><div class="title">HighUse</div><div class="text"> </div><div class="title">Requests</div><div class="text"> </div><div class="title">Size(s)</div></div><div class="line"><div class="data" data-tag="type"> name</div><div class="text"> </div><div class="data" data-tag="in-use">12345</div><div class="text"> </div><div class="data" data-tag="memory-use">54321</div><div class="units">K</div><div class="text"> </div><div class="data" data-tag="high-use"> -</div><div class="text"> </div><div class="data" data-tag="requests"> 32145</div><div class="text"> </div></div><div class="line"><div class="data" data-tag="first-name">Terry</div><div class="text"> </div><div class="data" data-tag="last-name">Jones</div><div class="text"> works in dept #</div><div class="data" data-tag="department">660</div></div><div class="line"><div class="data" data-tag="first-name">Leslie</div><div class="text"> </div><div class="data" data-tag="last-name">Patterson</div><div class="text"> works in dept #</div><div class="data" data-tag="department">341</div></div><div class="line"><div class="data" data-tag="first-name">Ashley</div><div class="text"> </div><div class="data" data-tag="last-name">Smith</div><div class="text"> works in dept #</div><div class="data" data-tag="department">1440</div></div><div class="line"><div class="text">done</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_03.HIPx.err b/contrib/libxo/tests/core/saved/test_03.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_03.HIPx.out b/contrib/libxo/tests/core/saved/test_03.HIPx.out new file mode 100644 index 000000000000..aaf867b6e87e --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.HIPx.out @@ -0,0 +1,55 @@ +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="extra" data-xpath="/employees/extra"></div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title"> Type</div> + <div class="text"> </div> + <div class="title">InUse</div> + <div class="text"> </div> + <div class="title">MemUse</div> + <div class="text"> </div> + <div class="title">HighUse</div> + <div class="text"> </div> + <div class="title">Requests</div> + <div class="text"> </div> + <div class="title">Size(s)</div> +</div> +<div class="line"> + <div class="data" data-tag="type" data-xpath="/employees/memory/type"> name</div> + <div class="text"> </div> + <div class="data" data-tag="in-use" data-xpath="/employees/memory[type = 'name']/in-use">12345</div> + <div class="text"> </div> + <div class="data" data-tag="memory-use" data-xpath="/employees/memory[type = 'name']/memory-use">54321</div> + <div class="units">K</div> + <div class="text"> </div> + <div class="data" data-tag="high-use" data-xpath="/employees/memory[type = 'name']/high-use"> -</div> + <div class="text"> </div> + <div class="data" data-tag="requests" data-xpath="/employees/memory[type = 'name']/requests"> 32145</div> + <div class="text"> </div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Terry</div> + <div class="text"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Jones</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department">660</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Leslie</div> + <div class="text"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Patterson</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department">341</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Ashley</div> + <div class="text"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Smith</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department">1440</div> +</div> +<div class="line"> + <div class="text">done</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_03.HP.err b/contrib/libxo/tests/core/saved/test_03.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.HP.err diff --git a/contrib/libxo/tests/core/saved/test_03.HP.out b/contrib/libxo/tests/core/saved/test_03.HP.out new file mode 100644 index 000000000000..2e476fbb78ee --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.HP.out @@ -0,0 +1,55 @@ +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="extra"></div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title"> Type</div> + <div class="text"> </div> + <div class="title">InUse</div> + <div class="text"> </div> + <div class="title">MemUse</div> + <div class="text"> </div> + <div class="title">HighUse</div> + <div class="text"> </div> + <div class="title">Requests</div> + <div class="text"> </div> + <div class="title">Size(s)</div> +</div> +<div class="line"> + <div class="data" data-tag="type"> name</div> + <div class="text"> </div> + <div class="data" data-tag="in-use">12345</div> + <div class="text"> </div> + <div class="data" data-tag="memory-use">54321</div> + <div class="units">K</div> + <div class="text"> </div> + <div class="data" data-tag="high-use"> -</div> + <div class="text"> </div> + <div class="data" data-tag="requests"> 32145</div> + <div class="text"> </div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Terry</div> + <div class="text"> </div> + <div class="data" data-tag="last-name">Jones</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department">660</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Leslie</div> + <div class="text"> </div> + <div class="data" data-tag="last-name">Patterson</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department">341</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Ashley</div> + <div class="text"> </div> + <div class="data" data-tag="last-name">Smith</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department">1440</div> +</div> +<div class="line"> + <div class="text">done</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_03.J.err b/contrib/libxo/tests/core/saved/test_03.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.J.err diff --git a/contrib/libxo/tests/core/saved/test_03.J.out b/contrib/libxo/tests/core/saved/test_03.J.out new file mode 100644 index 000000000000..5902a79126be --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.J.out @@ -0,0 +1 @@ +{"employees": {"employee": [],"extra":"", "memory": [{"type":"name","in-use":12345,"memory-use":54321,"high-use":"-","requests":32145}], "employee": [{"first-name":"Terry","last-name":"Jones","department":660}, {"first-name":"Leslie","last-name":"Patterson","department":341}, {"first-name":"Ashley","last-name":"Smith","department":1440}]}} diff --git a/contrib/libxo/tests/core/saved/test_03.JP.err b/contrib/libxo/tests/core/saved/test_03.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.JP.err diff --git a/contrib/libxo/tests/core/saved/test_03.JP.out b/contrib/libxo/tests/core/saved/test_03.JP.out new file mode 100644 index 000000000000..a62f47ecde34 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.JP.out @@ -0,0 +1,33 @@ +{ + "employees": { + "employee": [ + ], + "extra": "", + "memory": [ + { + "type": "name", + "in-use": 12345, + "memory-use": 54321, + "high-use": "-", + "requests": 32145 + } + ], + "employee": [ + { + "first-name": "Terry", + "last-name": "Jones", + "department": 660 + }, + { + "first-name": "Leslie", + "last-name": "Patterson", + "department": 341 + }, + { + "first-name": "Ashley", + "last-name": "Smith", + "department": 1440 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_03.JPu.err b/contrib/libxo/tests/core/saved/test_03.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_03.JPu.out b/contrib/libxo/tests/core/saved/test_03.JPu.out new file mode 100644 index 000000000000..d0c3ccf45b59 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.JPu.out @@ -0,0 +1,33 @@ +{ + "employees": { + "employee": [ + ], + "extra": "", + "memory": [ + { + "type": "name", + "in_use": 12345, + "memory_use": 54321, + "high_use": "-", + "requests": 32145 + } + ], + "employee": [ + { + "first_name": "Terry", + "last_name": "Jones", + "department": 660 + }, + { + "first_name": "Leslie", + "last_name": "Patterson", + "department": 341 + }, + { + "first_name": "Ashley", + "last_name": "Smith", + "department": 1440 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_03.T.err b/contrib/libxo/tests/core/saved/test_03.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.T.err diff --git a/contrib/libxo/tests/core/saved/test_03.T.out b/contrib/libxo/tests/core/saved/test_03.T.out new file mode 100644 index 000000000000..90486fb3c3d2 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.T.out @@ -0,0 +1,7 @@ +[] + Type InUse MemUse HighUse Requests Size(s) + name 12345 54321K - 32145 +Terry Jones works in dept #660 +Leslie Patterson works in dept #341 +Ashley Smith works in dept #1440 +done diff --git a/contrib/libxo/tests/core/saved/test_03.X.err b/contrib/libxo/tests/core/saved/test_03.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.X.err diff --git a/contrib/libxo/tests/core/saved/test_03.X.out b/contrib/libxo/tests/core/saved/test_03.X.out new file mode 100644 index 000000000000..279e359d5f60 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.X.out @@ -0,0 +1 @@ +<employees><extra></extra><memory><type>name</type><in-use>12345</in-use><memory-use>54321</memory-use><high-use>-</high-use><requests>32145</requests></memory><employee><first-name>Terry</first-name><last-name>Jones</last-name><department>660</department></employee><employee><first-name>Leslie</first-name><last-name>Patterson</last-name><department>341</department></employee><employee><first-name>Ashley</first-name><last-name>Smith</last-name><department>1440</department></employee></employees>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_03.XP.err b/contrib/libxo/tests/core/saved/test_03.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.XP.err diff --git a/contrib/libxo/tests/core/saved/test_03.XP.out b/contrib/libxo/tests/core/saved/test_03.XP.out new file mode 100644 index 000000000000..751bbfcd9eb3 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.XP.out @@ -0,0 +1,25 @@ +<employees> + <extra></extra> + <memory> + <type>name</type> + <in-use>12345</in-use> + <memory-use>54321</memory-use> + <high-use>-</high-use> + <requests>32145</requests> + </memory> + <employee> + <first-name>Terry</first-name> + <last-name>Jones</last-name> + <department>660</department> + </employee> + <employee> + <first-name>Leslie</first-name> + <last-name>Patterson</last-name> + <department>341</department> + </employee> + <employee> + <first-name>Ashley</first-name> + <last-name>Smith</last-name> + <department>1440</department> + </employee> +</employees> diff --git a/contrib/libxo/tests/core/saved/test_03.err b/contrib/libxo/tests/core/saved/test_03.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.err diff --git a/contrib/libxo/tests/core/saved/test_03.out b/contrib/libxo/tests/core/saved/test_03.out new file mode 100644 index 000000000000..da60fb7c9ab3 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_03.out @@ -0,0 +1,3 @@ +Terry Jones works in dept #660 +Leslie Patterson works in dept #341 +Ashley Smith works in dept #1440 diff --git a/contrib/libxo/tests/core/saved/test_04.E.err b/contrib/libxo/tests/core/saved/test_04.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.E.err diff --git a/contrib/libxo/tests/core/saved/test_04.E.out b/contrib/libxo/tests/core/saved/test_04.E.out new file mode 100644 index 000000000000..d5d53aedc485 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.E.out @@ -0,0 +1,22 @@ +op create: [test] [] [0] +op open_container: [employees] [] [0x10] +op open_list: [employee] [] [0] +op open_instance: [employee] [] [0x10] +op string: [first-name] [Terry] [0] +op string: [last-name] [Jones] [0] +op content: [department] [660] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x10] +op string: [first-name] [Leslie] [0] +op string: [last-name] [Patterson] [0] +op content: [department] [341] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x10] +op string: [first-name] [Ashley] [0] +op string: [last-name] [Smith] [0] +op content: [department] [1440] [0] +op close_instance: [employee] [] [0] +op close_list: [employee] [] [0] +op close_container: [employees] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_04.H.err b/contrib/libxo/tests/core/saved/test_04.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.H.err diff --git a/contrib/libxo/tests/core/saved/test_04.H.out b/contrib/libxo/tests/core/saved/test_04.H.out new file mode 100644 index 000000000000..175823610617 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.H.out @@ -0,0 +1 @@ +<div class="line"><div class="title">Last Name </div><div class="title">First Name </div><div class="title">Department</div></div><div class="line"><div class="data" data-tag="first-name">Terry </div><div class="data" data-tag="last-name">Jones </div><div class="data" data-tag="department"> 660</div></div><div class="line"><div class="data" data-tag="first-name">Leslie </div><div class="data" data-tag="last-name">Patterson </div><div class="data" data-tag="department"> 341</div></div><div class="line"><div class="data" data-tag="first-name">Ashley </div><div class="data" data-tag="last-name">Smith </div><div class="data" data-tag="department"> 1440</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_04.HIPx.err b/contrib/libxo/tests/core/saved/test_04.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_04.HIPx.out b/contrib/libxo/tests/core/saved/test_04.HIPx.out new file mode 100644 index 000000000000..473113befbac --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.HIPx.out @@ -0,0 +1,20 @@ +<div class="line"> + <div class="title">Last Name </div> + <div class="title">First Name </div> + <div class="title">Department</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Terry </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Jones </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 660</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Leslie </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Patterson </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 341</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Ashley </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Smith </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 1440</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_04.HP.err b/contrib/libxo/tests/core/saved/test_04.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.HP.err diff --git a/contrib/libxo/tests/core/saved/test_04.HP.out b/contrib/libxo/tests/core/saved/test_04.HP.out new file mode 100644 index 000000000000..d56f8f49c05e --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.HP.out @@ -0,0 +1,20 @@ +<div class="line"> + <div class="title">Last Name </div> + <div class="title">First Name </div> + <div class="title">Department</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Terry </div> + <div class="data" data-tag="last-name">Jones </div> + <div class="data" data-tag="department"> 660</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Leslie </div> + <div class="data" data-tag="last-name">Patterson </div> + <div class="data" data-tag="department"> 341</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Ashley </div> + <div class="data" data-tag="last-name">Smith </div> + <div class="data" data-tag="department"> 1440</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_04.J.err b/contrib/libxo/tests/core/saved/test_04.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.J.err diff --git a/contrib/libxo/tests/core/saved/test_04.J.out b/contrib/libxo/tests/core/saved/test_04.J.out new file mode 100644 index 000000000000..94e01146e735 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.J.out @@ -0,0 +1 @@ +{"employees": {"employee": [{"first-name":"Terry","last-name":"Jones","department":660}, {"first-name":"Leslie","last-name":"Patterson","department":341}, {"first-name":"Ashley","last-name":"Smith","department":1440}]}} diff --git a/contrib/libxo/tests/core/saved/test_04.JP.err b/contrib/libxo/tests/core/saved/test_04.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.JP.err diff --git a/contrib/libxo/tests/core/saved/test_04.JP.out b/contrib/libxo/tests/core/saved/test_04.JP.out new file mode 100644 index 000000000000..ff2d5b033dda --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.JP.out @@ -0,0 +1,21 @@ +{ + "employees": { + "employee": [ + { + "first-name": "Terry", + "last-name": "Jones", + "department": 660 + }, + { + "first-name": "Leslie", + "last-name": "Patterson", + "department": 341 + }, + { + "first-name": "Ashley", + "last-name": "Smith", + "department": 1440 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_04.JPu.err b/contrib/libxo/tests/core/saved/test_04.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_04.JPu.out b/contrib/libxo/tests/core/saved/test_04.JPu.out new file mode 100644 index 000000000000..b0f802dc03fd --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.JPu.out @@ -0,0 +1,21 @@ +{ + "employees": { + "employee": [ + { + "first_name": "Terry", + "last_name": "Jones", + "department": 660 + }, + { + "first_name": "Leslie", + "last_name": "Patterson", + "department": 341 + }, + { + "first_name": "Ashley", + "last_name": "Smith", + "department": 1440 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_04.T.err b/contrib/libxo/tests/core/saved/test_04.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.T.err diff --git a/contrib/libxo/tests/core/saved/test_04.T.out b/contrib/libxo/tests/core/saved/test_04.T.out new file mode 100644 index 000000000000..aca80c417e03 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.T.out @@ -0,0 +1,4 @@ +Last Name First Name Department +Terry Jones 660 +Leslie Patterson 341 +Ashley Smith 1440 diff --git a/contrib/libxo/tests/core/saved/test_04.X.err b/contrib/libxo/tests/core/saved/test_04.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.X.err diff --git a/contrib/libxo/tests/core/saved/test_04.X.out b/contrib/libxo/tests/core/saved/test_04.X.out new file mode 100644 index 000000000000..a626fb6679d9 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.X.out @@ -0,0 +1 @@ +<employees><employee><first-name>Terry</first-name><last-name>Jones</last-name><department>660</department></employee><employee><first-name>Leslie</first-name><last-name>Patterson</last-name><department>341</department></employee><employee><first-name>Ashley</first-name><last-name>Smith</last-name><department>1440</department></employee></employees>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_04.XP.err b/contrib/libxo/tests/core/saved/test_04.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.XP.err diff --git a/contrib/libxo/tests/core/saved/test_04.XP.out b/contrib/libxo/tests/core/saved/test_04.XP.out new file mode 100644 index 000000000000..b6e764180dad --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_04.XP.out @@ -0,0 +1,17 @@ +<employees> + <employee> + <first-name>Terry</first-name> + <last-name>Jones</last-name> + <department>660</department> + </employee> + <employee> + <first-name>Leslie</first-name> + <last-name>Patterson</last-name> + <department>341</department> + </employee> + <employee> + <first-name>Ashley</first-name> + <last-name>Smith</last-name> + <department>1440</department> + </employee> +</employees> diff --git a/contrib/libxo/tests/core/saved/test_05.E.err b/contrib/libxo/tests/core/saved/test_05.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.E.err diff --git a/contrib/libxo/tests/core/saved/test_05.E.out b/contrib/libxo/tests/core/saved/test_05.E.out new file mode 100644 index 000000000000..904a616ce7ce --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.E.out @@ -0,0 +1,96 @@ +op create: [test] [] [0] +op open_container: [indian-languages] [] [0x200010] +op string: [gurmukhi] [ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।] [0] +op string: [shahmukhi] [لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔] [0] +op string: [tranliteration] [lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē.] [0] +op close_container: [indian-languages] [] [0] +op open_container: [employees] [] [0x200010] +op open_leaf_list: [wc] [] [0] +op string: [wc] [෴ - 0xdf4 - 1] [0x2010] +op string: [wc] [ණ - 0xdab - 1] [0x2010] +op string: [wc] [් - 0xdca - 0] [0x2010] +op string: [wc] [ණ - 0xdab - 1] [0x2010] +op string: [wc] [្ - 0x17d2 - 0] [0x2010] +op string: [wc] [෴ - 0xdf4 - 1] [0x2010] +op string: [wc] [1 - 0x31 - 1] [0x2010] +op string: [wc] [͏ - 0x34f - 0] [0x2010] +op string: [wc] [2 - 0x32 - 1] [0x2010] +op string: [wc] [⃝ - 0x20dd - 0] [0x2010] +op close_leaf_list: [wc] [] [0] +op string: [fancy] [1͏2⃝] [0] +op string: [v1] [γιγνώσκειν] [0] +op string: [v2] [ὦ ἄνδρες ᾿Αθηναῖοι] [0] +op string: [v1] [ახლავე გაიაროთ რეგისტრაცია] [0] +op string: [v2] [Unicode-ის მეათე საერთაშორისო] [0] +op content: [width] [55] [0] +op string: [sinhala] [෴ණ්ණ෴] [0] +op content: [width] [4] [0] +op string: [sinhala] [෴] [0] +op content: [width] [1] [0] +op string: [sinhala] [෴ණ්ණ෴෴ණ්ණ෴] [0] +op content: [width] [8] [0] +op string: [not-sinhala] [123456] [0] +op string: [tag] [ර්ඝ] [0] +op content: [width] [2] [0] +op open_list: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Jim] [0] +op string: [nic-name] ["რეგტ"] [0] +op string: [last-name] [გთხოვთ ახ] [0] +op content: [department] [431] [0] +op content: [percent-time] [90] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Terry] [0] +op string: [nic-name] ["<one"] [0] +op string: [last-name] [Οὐχὶ ταὐτὰ παρίσταταί μοι Jones] [0] +op content: [department] [660] [0] +op content: [percent-time] [90] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Leslie] [0] +op string: [nic-name] ["Les"] [0] +op string: [last-name] [Patterson] [0] +op content: [department] [341] [0] +op content: [percent-time] [60] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Ashley] [0] +op string: [nic-name] ["Ash"] [0] +op string: [last-name] [Meter & Smith] [0] +op content: [department] [1440] [0] +op content: [percent-time] [40] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [0123456789] [0] +op string: [nic-name] ["0123456789"] [0] +op string: [last-name] [012345678901234567890] [0] +op content: [department] [1440] [0] +op content: [percent-time] [40] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [ახლა] [0] +op string: [nic-name] ["გაიარო"] [0] +op string: [last-name] [საერთაშორისო] [0] +op content: [department] [123] [0] +op content: [percent-time] [90] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [෴ණ්ණ෴෴ණ්ණ෴] [0] +op string: [nic-name] ["Mick"] [0] +op string: [last-name] [෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴] [0] +op content: [department] [110] [0] +op content: [percent-time] [20] [0] +op close_instance: [employee] [] [0] +op close_list: [employee] [] [0] +op close_container: [employees] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_05.H.err b/contrib/libxo/tests/core/saved/test_05.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.H.err diff --git a/contrib/libxo/tests/core/saved/test_05.H.out b/contrib/libxo/tests/core/saved/test_05.H.out new file mode 100644 index 000000000000..e8fd6d11d26e --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.H.out @@ -0,0 +1 @@ +<div class="line"><div class="title">Sample text</div></div><div class="line"><div class="text">This sample text was taken from the Punjabi Wikipedia article on Lahore and transliterated into the Latin script.</div></div><div class="line"><div class="title">Gurmukhi:</div></div><div class="line"><div class="data" data-tag="gurmukhi">ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।</div></div><div class="line"><div class="title">Shahmukhi:</div></div><div class="line"><div class="data" data-tag="shahmukhi">لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔</div></div><div class="line"><div class="title">Transliteration</div><div class="text">:</div></div><div class="line"><div class="data" data-tag="tranliteration">lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē.</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">෴ - 0xdf4 - 1</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">ණ - 0xdab - 1</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">් - 0xdca - 0</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">ණ - 0xdab - 1</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">្ - 0x17d2 - 0</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">෴ - 0xdf4 - 1</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">1 - 0x31 - 1</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">͏ - 0x34f - 0</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">2 - 0x32 - 1</div></div><div class="line"><div class="text">Wide char: </div><div class="data" data-tag="wc">⃝ - 0x20dd - 0</div></div><div class="line"><div class="text">Cool: [</div><div class="data" data-tag="fancy">1͏2⃝</div><div class="text">]</div></div><div class="line"><div class="text">Οὐχὶ ταὐτὰ παρίσταταί μοι </div><div class="data" data-tag="v1">γιγνώσκειν</div><div class="text">, </div><div class="data" data-tag="v2">ὦ ἄνδρες ᾿Αθηναῖοι</div></div><div class="line"><div class="text">გთხოვთ </div><div class="data" data-tag="v1">ახლავე გაიაროთ რეგისტრაცია</div><div class="text"> </div><div class="data" data-tag="v2">Unicode-ის მეათე საერთაშორისო</div></div><div class="line"><div class="title">Width</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="width">63</div></div><div class="line"><div class="text">[</div><div class="data" data-tag="sinhala">෴ණ්ණ෴</div><div class="text">]</div></div><div class="line"><div class="title">Width</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="width">6</div></div><div class="line"><div class="text">[</div><div class="data" data-tag="sinhala">෴</div><div class="text">]</div></div><div class="line"><div class="title">Width</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="width">3</div></div><div class="line"><div class="text">[</div><div class="data" data-tag="sinhala">෴ණ්ණ෴</div><div class="text">]</div></div><div class="line"><div class="title">Width</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="width">6</div></div><div class="line"><div class="text">[</div><div class="data" data-tag="not-sinhala">1234</div><div class="text">]</div></div><div class="line"><div class="text">[</div><div class="data" data-tag="tag">ර්ඝ</div><div class="text">]</div></div><div class="line"><div class="title">Width</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="width">4</div></div><div class="line"><div class="title">First Name </div><div class="title">Last Name </div><div class="title">Department </div><div class="title">Time (%)</div></div><div class="line"><div class="data" data-tag="first-name">Jim</div><div class="text"> (</div><div class="data" data-tag="nic-name">"რეგტ"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">გთხოვთ ახ </div><div class="data" data-tag="department"> 431</div><div class="data" data-tag="percent-time"> 90</div></div><div class="line"><div class="data" data-tag="first-name">Terry</div><div class="text"> (</div><div class="data" data-tag="nic-name">"<one"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">Οὐχὶ ταὐτὰ παρ</div><div class="data" data-tag="department"> 660</div><div class="data" data-tag="percent-time"> 90</div></div><div class="line"><div class="data" data-tag="first-name">Leslie</div><div class="text"> (</div><div class="data" data-tag="nic-name">"Les"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">Patterson </div><div class="data" data-tag="department"> 341</div><div class="data" data-tag="percent-time"> 60</div></div><div class="line"><div class="data" data-tag="first-name">Ashley</div><div class="text"> (</div><div class="data" data-tag="nic-name">"Ash"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">Meter & Smith </div><div class="data" data-tag="department"> 1440</div><div class="data" data-tag="percent-time"> 40</div></div><div class="line"><div class="data" data-tag="first-name">0123456789</div><div class="text"> (</div><div class="data" data-tag="nic-name">"0123456789"</div><div class="text">)</div><div class="data" data-tag="last-name">01234567890123</div><div class="data" data-tag="department"> 1440</div><div class="data" data-tag="percent-time"> 40</div></div><div class="line"><div class="data" data-tag="first-name">ახლა</div><div class="text"> (</div><div class="data" data-tag="nic-name">"გაიარო"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">საერთაშორისო </div><div class="data" data-tag="department"> 123</div><div class="data" data-tag="percent-time"> 90</div></div><div class="line"><div class="data" data-tag="first-name">෴ණ්ණ෴෴ණ්ණ෴</div><div class="text"> (</div><div class="data" data-tag="nic-name">"Mick"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴</div><div class="data" data-tag="department"> 110</div><div class="data" data-tag="percent-time"> 20</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_05.HIPx.err b/contrib/libxo/tests/core/saved/test_05.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_05.HIPx.out b/contrib/libxo/tests/core/saved/test_05.HIPx.out new file mode 100644 index 000000000000..4389b85a3fd6 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.HIPx.out @@ -0,0 +1,212 @@ +<div class="line"> + <div class="title">Sample text</div> +</div> +<div class="line"> + <div class="text">This sample text was taken from the Punjabi Wikipedia article on Lahore and transliterated into the Latin script.</div> +</div> +<div class="line"> + <div class="title">Gurmukhi:</div> +</div> +<div class="line"> + <div class="data" data-tag="gurmukhi" data-xpath="/indian-languages/gurmukhi">ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।</div> +</div> +<div class="line"> + <div class="title">Shahmukhi:</div> +</div> +<div class="line"> + <div class="data" data-tag="shahmukhi" data-xpath="/indian-languages/shahmukhi">لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔</div> +</div> +<div class="line"> + <div class="title">Transliteration</div> + <div class="text">:</div> +</div> +<div class="line"> + <div class="data" data-tag="tranliteration" data-xpath="/indian-languages/tranliteration">lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē.</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">෴ - 0xdf4 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">ණ - 0xdab - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">් - 0xdca - 0</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">ණ - 0xdab - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">្ - 0x17d2 - 0</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">෴ - 0xdf4 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">1 - 0x31 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">͏ - 0x34f - 0</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">2 - 0x32 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc" data-xpath="/employees/wc">⃝ - 0x20dd - 0</div> +</div> +<div class="line"> + <div class="text">Cool: [</div> + <div class="data" data-tag="fancy" data-xpath="/employees/fancy">1͏2⃝</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="text">Οὐχὶ ταὐτὰ παρίσταταί μοι </div> + <div class="data" data-tag="v1" data-xpath="/employees/v1">γιγνώσκειν</div> + <div class="text">, </div> + <div class="data" data-tag="v2" data-xpath="/employees/v2">ὦ ἄνδρες ᾿Αθηναῖοι</div> +</div> +<div class="line"> + <div class="text">გთხოვთ </div> + <div class="data" data-tag="v1" data-xpath="/employees/v1">ახლავე გაიაროთ რეგისტრაცია</div> + <div class="text"> </div> + <div class="data" data-tag="v2" data-xpath="/employees/v2">Unicode-ის მეათე საერთაშორისო</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width" data-xpath="/employees/width">63</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="sinhala" data-xpath="/employees/sinhala">෴ණ්ණ෴</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width" data-xpath="/employees/width">6</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="sinhala" data-xpath="/employees/sinhala">෴</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width" data-xpath="/employees/width">3</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="sinhala" data-xpath="/employees/sinhala">෴ණ්ණ෴</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width" data-xpath="/employees/width">6</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="not-sinhala" data-xpath="/employees/not-sinhala">1234</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="tag" data-xpath="/employees/tag">ර්ඝ</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width" data-xpath="/employees/width">4</div> +</div> +<div class="line"> + <div class="title">First Name </div> + <div class="title">Last Name </div> + <div class="title">Department </div> + <div class="title">Time (%)</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Jim</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"რეგტ"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">გთხოვთ ახ </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 431</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Terry</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"<one"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Οὐχὶ ταὐτὰ παρ</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 660</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Leslie</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"Les"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Patterson </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 341</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 60</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Ashley</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"Ash"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Meter & Smith </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 1440</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">0123456789</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"0123456789"</div> + <div class="text">)</div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">01234567890123</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 1440</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">ახლა</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"გაიარო"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">საერთაშორისო </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 123</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">෴ණ්ණ෴෴ණ්ණ෴</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"Mick"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 110</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 20</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_05.HP.err b/contrib/libxo/tests/core/saved/test_05.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.HP.err diff --git a/contrib/libxo/tests/core/saved/test_05.HP.out b/contrib/libxo/tests/core/saved/test_05.HP.out new file mode 100644 index 000000000000..e3fcdda0263c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.HP.out @@ -0,0 +1,212 @@ +<div class="line"> + <div class="title">Sample text</div> +</div> +<div class="line"> + <div class="text">This sample text was taken from the Punjabi Wikipedia article on Lahore and transliterated into the Latin script.</div> +</div> +<div class="line"> + <div class="title">Gurmukhi:</div> +</div> +<div class="line"> + <div class="data" data-tag="gurmukhi">ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।</div> +</div> +<div class="line"> + <div class="title">Shahmukhi:</div> +</div> +<div class="line"> + <div class="data" data-tag="shahmukhi">لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔</div> +</div> +<div class="line"> + <div class="title">Transliteration</div> + <div class="text">:</div> +</div> +<div class="line"> + <div class="data" data-tag="tranliteration">lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē.</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">෴ - 0xdf4 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">ණ - 0xdab - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">් - 0xdca - 0</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">ණ - 0xdab - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">្ - 0x17d2 - 0</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">෴ - 0xdf4 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">1 - 0x31 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">͏ - 0x34f - 0</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">2 - 0x32 - 1</div> +</div> +<div class="line"> + <div class="text">Wide char: </div> + <div class="data" data-tag="wc">⃝ - 0x20dd - 0</div> +</div> +<div class="line"> + <div class="text">Cool: [</div> + <div class="data" data-tag="fancy">1͏2⃝</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="text">Οὐχὶ ταὐτὰ παρίσταταί μοι </div> + <div class="data" data-tag="v1">γιγνώσκειν</div> + <div class="text">, </div> + <div class="data" data-tag="v2">ὦ ἄνδρες ᾿Αθηναῖοι</div> +</div> +<div class="line"> + <div class="text">გთხოვთ </div> + <div class="data" data-tag="v1">ახლავე გაიაროთ რეგისტრაცია</div> + <div class="text"> </div> + <div class="data" data-tag="v2">Unicode-ის მეათე საერთაშორისო</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width">63</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="sinhala">෴ණ්ණ෴</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width">6</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="sinhala">෴</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width">3</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="sinhala">෴ණ්ණ෴</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width">6</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="not-sinhala">1234</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="text">[</div> + <div class="data" data-tag="tag">ර්ඝ</div> + <div class="text">]</div> +</div> +<div class="line"> + <div class="title">Width</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="width">4</div> +</div> +<div class="line"> + <div class="title">First Name </div> + <div class="title">Last Name </div> + <div class="title">Department </div> + <div class="title">Time (%)</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Jim</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"რეგტ"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">გთხოვთ ახ </div> + <div class="data" data-tag="department"> 431</div> + <div class="data" data-tag="percent-time"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Terry</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"<one"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">Οὐχὶ ταὐτὰ παρ</div> + <div class="data" data-tag="department"> 660</div> + <div class="data" data-tag="percent-time"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Leslie</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"Les"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">Patterson </div> + <div class="data" data-tag="department"> 341</div> + <div class="data" data-tag="percent-time"> 60</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Ashley</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"Ash"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">Meter & Smith </div> + <div class="data" data-tag="department"> 1440</div> + <div class="data" data-tag="percent-time"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">0123456789</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"0123456789"</div> + <div class="text">)</div> + <div class="data" data-tag="last-name">01234567890123</div> + <div class="data" data-tag="department"> 1440</div> + <div class="data" data-tag="percent-time"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">ახლა</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"გაიარო"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">საერთაშორისო </div> + <div class="data" data-tag="department"> 123</div> + <div class="data" data-tag="percent-time"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">෴ණ්ණ෴෴ණ්ණ෴</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"Mick"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴</div> + <div class="data" data-tag="department"> 110</div> + <div class="data" data-tag="percent-time"> 20</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_05.J.err b/contrib/libxo/tests/core/saved/test_05.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.J.err diff --git a/contrib/libxo/tests/core/saved/test_05.J.out b/contrib/libxo/tests/core/saved/test_05.J.out new file mode 100644 index 000000000000..0db0a65fb06b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.J.out @@ -0,0 +1 @@ +{"indian-languages": {"gurmukhi":"ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।","shahmukhi":"لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔","tranliteration":"lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē."}, "employees": {"wc": ["෴ - 0xdf4 - 1","ණ - 0xdab - 1","් - 0xdca - 0","ණ - 0xdab - 1","្ - 0x17d2 - 0","෴ - 0xdf4 - 1","1 - 0x31 - 1","͏ - 0x34f - 0","2 - 0x32 - 1","⃝ - 0x20dd - 0"],"fancy":"1͏2⃝","v1":"γιγνώσκειν","v2":"ὦ ἄνδρες ᾿Αθηναῖοι","v1":"ახლავე გაიაროთ რეგისტრაცია","v2":"Unicode-ის მეათე საერთაშორისო","width":55,"sinhala":"෴ණ්ණ෴","width":4,"sinhala":"෴","width":1,"sinhala":"෴ණ්ණ෴෴ණ්ණ෴","width":8,"not-sinhala":"123456","tag":"ර්ඝ","width":2, "employee": [{"first-name":"Jim","nic-name":"\"რეგტ\"","last-name":"გთხოვთ ახ","department":431,"percent-time":90,"benefits":"full"}, {"first-name":"Terry","nic-name":"\"<one\"","last-name":"Οὐχὶ ταὐτὰ παρίσταταί μοι Jones","department":660,"percent-time":90,"benefits":"full"}, {"first-name":"Leslie","nic-name":"\"Les\"","last-name":"Patterson","department":341,"percent-time":60,"benefits":"full"}, {"first-name":"Ashley","nic-name":"\"Ash\"","last-name":"Meter & Smith","department":1440,"percent-time":40}, {"first-name":"0123456789","nic-name":"\"0123456789\"","last-name":"012345678901234567890","department":1440,"percent-time":40}, {"first-name":"ახლა","nic-name":"\"გაიარო\"","last-name":"საერთაშორისო","department":123,"percent-time":90,"benefits":"full"}, {"first-name":"෴ණ්ණ෴෴ණ්ණ෴","nic-name":"\"Mick\"","last-name":"෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴","department":110,"percent-time":20}]}} diff --git a/contrib/libxo/tests/core/saved/test_05.JP.err b/contrib/libxo/tests/core/saved/test_05.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.JP.err diff --git a/contrib/libxo/tests/core/saved/test_05.JP.out b/contrib/libxo/tests/core/saved/test_05.JP.out new file mode 100644 index 000000000000..5bf14118cbaa --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.JP.out @@ -0,0 +1,91 @@ +{ + "indian-languages": { + "gurmukhi": "ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।", + "shahmukhi": "لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔", + "tranliteration": "lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē." + }, + "employees": { + "wc": [ + "෴ - 0xdf4 - 1", + "ණ - 0xdab - 1", + "් - 0xdca - 0", + "ණ - 0xdab - 1", + "្ - 0x17d2 - 0", + "෴ - 0xdf4 - 1", + "1 - 0x31 - 1", + "͏ - 0x34f - 0", + "2 - 0x32 - 1", + "⃝ - 0x20dd - 0" + ], + "fancy": "1͏2⃝", + "v1": "γιγνώσκειν", + "v2": "ὦ ἄνδρες ᾿Αθηναῖοι", + "v1": "ახლავე გაიაროთ რეგისტრაცია", + "v2": "Unicode-ის მეათე საერთაშორისო", + "width": 55, + "sinhala": "෴ණ්ණ෴", + "width": 4, + "sinhala": "෴", + "width": 1, + "sinhala": "෴ණ්ණ෴෴ණ්ණ෴", + "width": 8, + "not-sinhala": "123456", + "tag": "ර්ඝ", + "width": 2, + "employee": [ + { + "first-name": "Jim", + "nic-name": "\"რეგტ\"", + "last-name": "გთხოვთ ახ", + "department": 431, + "percent-time": 90, + "benefits": "full" + }, + { + "first-name": "Terry", + "nic-name": "\"<one\"", + "last-name": "Οὐχὶ ταὐτὰ παρίσταταί μοι Jones", + "department": 660, + "percent-time": 90, + "benefits": "full" + }, + { + "first-name": "Leslie", + "nic-name": "\"Les\"", + "last-name": "Patterson", + "department": 341, + "percent-time": 60, + "benefits": "full" + }, + { + "first-name": "Ashley", + "nic-name": "\"Ash\"", + "last-name": "Meter & Smith", + "department": 1440, + "percent-time": 40 + }, + { + "first-name": "0123456789", + "nic-name": "\"0123456789\"", + "last-name": "012345678901234567890", + "department": 1440, + "percent-time": 40 + }, + { + "first-name": "ახლა", + "nic-name": "\"გაიარო\"", + "last-name": "საერთაშორისო", + "department": 123, + "percent-time": 90, + "benefits": "full" + }, + { + "first-name": "෴ණ්ණ෴෴ණ්ණ෴", + "nic-name": "\"Mick\"", + "last-name": "෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴", + "department": 110, + "percent-time": 20 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_05.JPu.err b/contrib/libxo/tests/core/saved/test_05.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_05.JPu.out b/contrib/libxo/tests/core/saved/test_05.JPu.out new file mode 100644 index 000000000000..9bcbf69df916 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.JPu.out @@ -0,0 +1,91 @@ +{ + "indian_languages": { + "gurmukhi": "ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।", + "shahmukhi": "لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔", + "tranliteration": "lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē." + }, + "employees": { + "wc": [ + "෴ - 0xdf4 - 1", + "ණ - 0xdab - 1", + "් - 0xdca - 0", + "ණ - 0xdab - 1", + "្ - 0x17d2 - 0", + "෴ - 0xdf4 - 1", + "1 - 0x31 - 1", + "͏ - 0x34f - 0", + "2 - 0x32 - 1", + "⃝ - 0x20dd - 0" + ], + "fancy": "1͏2⃝", + "v1": "γιγνώσκειν", + "v2": "ὦ ἄνδρες ᾿Αθηναῖοι", + "v1": "ახლავე გაიაროთ რეგისტრაცია", + "v2": "Unicode-ის მეათე საერთაშორისო", + "width": 55, + "sinhala": "෴ණ්ණ෴", + "width": 4, + "sinhala": "෴", + "width": 1, + "sinhala": "෴ණ්ණ෴෴ණ්ණ෴", + "width": 8, + "not_sinhala": "123456", + "tag": "ර්ඝ", + "width": 2, + "employee": [ + { + "first_name": "Jim", + "nic_name": "\"რეგტ\"", + "last_name": "გთხოვთ ახ", + "department": 431, + "percent_time": 90, + "benefits": "full" + }, + { + "first_name": "Terry", + "nic_name": "\"<one\"", + "last_name": "Οὐχὶ ταὐτὰ παρίσταταί μοι Jones", + "department": 660, + "percent_time": 90, + "benefits": "full" + }, + { + "first_name": "Leslie", + "nic_name": "\"Les\"", + "last_name": "Patterson", + "department": 341, + "percent_time": 60, + "benefits": "full" + }, + { + "first_name": "Ashley", + "nic_name": "\"Ash\"", + "last_name": "Meter & Smith", + "department": 1440, + "percent_time": 40 + }, + { + "first_name": "0123456789", + "nic_name": "\"0123456789\"", + "last_name": "012345678901234567890", + "department": 1440, + "percent_time": 40 + }, + { + "first_name": "ახლა", + "nic_name": "\"გაიარო\"", + "last_name": "საერთაშორისო", + "department": 123, + "percent_time": 90, + "benefits": "full" + }, + { + "first_name": "෴ණ්ණ෴෴ණ්ණ෴", + "nic_name": "\"Mick\"", + "last_name": "෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴", + "department": 110, + "percent_time": 20 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_05.T.err b/contrib/libxo/tests/core/saved/test_05.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.T.err diff --git a/contrib/libxo/tests/core/saved/test_05.T.out b/contrib/libxo/tests/core/saved/test_05.T.out new file mode 100644 index 000000000000..397a64eee794 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.T.out @@ -0,0 +1,39 @@ +Sample text +This sample text was taken from the Punjabi Wikipedia article on Lahore and transliterated into the Latin script. +Gurmukhi: +ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ । +Shahmukhi: +لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔ +Transliteration: +lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē. +Wide char: ෴ - 0xdf4 - 1 +Wide char: ණ - 0xdab - 1 +Wide char: ් - 0xdca - 0 +Wide char: ණ - 0xdab - 1 +Wide char: ្ - 0x17d2 - 0 +Wide char: ෴ - 0xdf4 - 1 +Wide char: 1 - 0x31 - 1 +Wide char: ͏ - 0x34f - 0 +Wide char: 2 - 0x32 - 1 +Wide char: ⃝ - 0x20dd - 0 +Cool: [1͏2⃝] +Οὐχὶ ταὐτὰ παρίσταταί μοι γιγνώσκειν, ὦ ἄνδρες ᾿Αθηναῖοι +გთხოვთ ახლავე გაიაროთ რეგისტრაცია Unicode-ის მეათე საერთაშორისო +Width: 63 +[෴ණ්ණ෴] +Width: 6 +[෴] +Width: 3 +[෴ණ්ණ෴] +Width: 6 +[1234] +[ර්ඝ] +Width: 4 +First Name Last Name Department Time (%) +Jim ("რეგტ") გთხოვთ ახ 431 90 +Terry ("<one") Οὐχὶ ταὐτὰ παρ 660 90 +Leslie ("Les") Patterson 341 60 +Ashley ("Ash") Meter & Smith 1440 40 +0123456789 ("0123456789")01234567890123 1440 40 +ახლა ("გაიარო") საერთაშორისო 123 90 +෴ණ්ණ෴෴ණ්ණ෴ ("Mick") ෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴ 110 20 diff --git a/contrib/libxo/tests/core/saved/test_05.X.err b/contrib/libxo/tests/core/saved/test_05.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.X.err diff --git a/contrib/libxo/tests/core/saved/test_05.X.out b/contrib/libxo/tests/core/saved/test_05.X.out new file mode 100644 index 000000000000..2a40010f4ac6 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.X.out @@ -0,0 +1 @@ +<indian-languages><gurmukhi>ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।</gurmukhi><shahmukhi>لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔</shahmukhi><tranliteration>lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē.</tranliteration></indian-languages><employees><wc>෴ - 0xdf4 - 1</wc><wc>ණ - 0xdab - 1</wc><wc>් - 0xdca - 0</wc><wc>ණ - 0xdab - 1</wc><wc>្ - 0x17d2 - 0</wc><wc>෴ - 0xdf4 - 1</wc><wc>1 - 0x31 - 1</wc><wc>͏ - 0x34f - 0</wc><wc>2 - 0x32 - 1</wc><wc>⃝ - 0x20dd - 0</wc><fancy>1͏2⃝</fancy><v1>γιγνώσκειν</v1><v2>ὦ ἄνδρες ᾿Αθηναῖοι</v2><v1>ახლავე გაიაროთ რეგისტრაცია</v1><v2>Unicode-ის მეათე საერთაშორისო</v2><width>55</width><sinhala>෴ණ්ණ෴</sinhala><width>4</width><sinhala>෴</sinhala><width>1</width><sinhala>෴ණ්ණ෴෴ණ්ණ෴</sinhala><width>8</width><not-sinhala>123456</not-sinhala><tag>ර්ඝ</tag><width>2</width><employee><first-name>Jim</first-name><nic-name>"რეგტ"</nic-name><last-name>გთხოვთ ახ</last-name><department>431</department><percent-time>90</percent-time><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>Terry</first-name><nic-name>"<one"</nic-name><last-name>Οὐχὶ ταὐτὰ παρίσταταί μοι Jones</last-name><department>660</department><percent-time>90</percent-time><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>Leslie</first-name><nic-name>"Les"</nic-name><last-name>Patterson</last-name><department>341</department><percent-time>60</percent-time><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>Ashley</first-name><nic-name>"Ash"</nic-name><last-name>Meter & Smith</last-name><department>1440</department><percent-time>40</percent-time></employee><employee><first-name>0123456789</first-name><nic-name>"0123456789"</nic-name><last-name>012345678901234567890</last-name><department>1440</department><percent-time>40</percent-time></employee><employee><first-name>ახლა</first-name><nic-name>"გაიარო"</nic-name><last-name>საერთაშორისო</last-name><department>123</department><percent-time>90</percent-time><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>෴ණ්ණ෴෴ණ්ණ෴</first-name><nic-name>"Mick"</nic-name><last-name>෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴</last-name><department>110</department><percent-time>20</percent-time></employee></employees>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_05.XP.err b/contrib/libxo/tests/core/saved/test_05.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.XP.err diff --git a/contrib/libxo/tests/core/saved/test_05.XP.out b/contrib/libxo/tests/core/saved/test_05.XP.out new file mode 100644 index 000000000000..cf48b5b9ebd5 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_05.XP.out @@ -0,0 +1,85 @@ +<indian-languages> + <gurmukhi>ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।</gurmukhi> + <shahmukhi>لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔</shahmukhi> + <tranliteration>lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē.</tranliteration> +</indian-languages> +<employees> + <wc>෴ - 0xdf4 - 1</wc> + <wc>ණ - 0xdab - 1</wc> + <wc>් - 0xdca - 0</wc> + <wc>ණ - 0xdab - 1</wc> + <wc>្ - 0x17d2 - 0</wc> + <wc>෴ - 0xdf4 - 1</wc> + <wc>1 - 0x31 - 1</wc> + <wc>͏ - 0x34f - 0</wc> + <wc>2 - 0x32 - 1</wc> + <wc>⃝ - 0x20dd - 0</wc> + <fancy>1͏2⃝</fancy> + <v1>γιγνώσκειν</v1> + <v2>ὦ ἄνδρες ᾿Αθηναῖοι</v2> + <v1>ახლავე გაიაროთ რეგისტრაცია</v1> + <v2>Unicode-ის მეათე საერთაშორისო</v2> + <width>55</width> + <sinhala>෴ණ්ණ෴</sinhala> + <width>4</width> + <sinhala>෴</sinhala> + <width>1</width> + <sinhala>෴ණ්ණ෴෴ණ්ණ෴</sinhala> + <width>8</width> + <not-sinhala>123456</not-sinhala> + <tag>ර්ඝ</tag> + <width>2</width> + <employee> + <first-name>Jim</first-name> + <nic-name>"რეგტ"</nic-name> + <last-name>გთხოვთ ახ</last-name> + <department>431</department> + <percent-time>90</percent-time> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>Terry</first-name> + <nic-name>"<one"</nic-name> + <last-name>Οὐχὶ ταὐτὰ παρίσταταί μοι Jones</last-name> + <department>660</department> + <percent-time>90</percent-time> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>Leslie</first-name> + <nic-name>"Les"</nic-name> + <last-name>Patterson</last-name> + <department>341</department> + <percent-time>60</percent-time> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>Ashley</first-name> + <nic-name>"Ash"</nic-name> + <last-name>Meter & Smith</last-name> + <department>1440</department> + <percent-time>40</percent-time> + </employee> + <employee> + <first-name>0123456789</first-name> + <nic-name>"0123456789"</nic-name> + <last-name>012345678901234567890</last-name> + <department>1440</department> + <percent-time>40</percent-time> + </employee> + <employee> + <first-name>ახლა</first-name> + <nic-name>"გაიარო"</nic-name> + <last-name>საერთაშორისო</last-name> + <department>123</department> + <percent-time>90</percent-time> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>෴ණ්ණ෴෴ණ්ණ෴</first-name> + <nic-name>"Mick"</nic-name> + <last-name>෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴</last-name> + <department>110</department> + <percent-time>20</percent-time> + </employee> +</employees> diff --git a/contrib/libxo/tests/core/saved/test_06.E.err b/contrib/libxo/tests/core/saved/test_06.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.E.err diff --git a/contrib/libxo/tests/core/saved/test_06.E.out b/contrib/libxo/tests/core/saved/test_06.E.out new file mode 100644 index 000000000000..eff90f86a66b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.E.out @@ -0,0 +1,22 @@ +op create: [test] [] [0] +op open_container: [employees] [] [0x410] +op open_list: [employee] [] [0] +op open_instance: [employee] [] [0x410] +op string: [first-name] [Terry] [0] +op string: [last-name] [Jones] [0] +op content: [department] [660] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x410] +op string: [first-name] [Leslie] [0] +op string: [last-name] [Patterson] [0] +op content: [department] [341] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x410] +op string: [first-name] [Ashley] [0] +op string: [last-name] [Smith] [0] +op content: [department] [1440] [0] +op close_instance: [employee] [] [0] +op close_list: [employee] [] [0] +op close_container: [employees] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_06.H.err b/contrib/libxo/tests/core/saved/test_06.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.H.err diff --git a/contrib/libxo/tests/core/saved/test_06.H.out b/contrib/libxo/tests/core/saved/test_06.H.out new file mode 100644 index 000000000000..6b9ccc435b80 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.H.out @@ -0,0 +1 @@ +<div class="line"><div class="data" data-tag="first-name">Terry</div><div class="text"> </div><div class="data" data-tag="last-name">Jones</div><div class="text"> works in dept #</div><div class="data" data-tag="department">660</div></div><div class="line"><div class="data" data-tag="first-name">Leslie</div><div class="text"> </div><div class="data" data-tag="last-name">Patterson</div><div class="text"> works in dept #</div><div class="data" data-tag="department">341</div></div><div class="line"><div class="data" data-tag="first-name">Ashley</div><div class="text"> </div><div class="data" data-tag="last-name">Smith</div><div class="text"> works in dept #</div><div class="data" data-tag="department">1440</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_06.HIPx.err b/contrib/libxo/tests/core/saved/test_06.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_06.HIPx.out b/contrib/libxo/tests/core/saved/test_06.HIPx.out new file mode 100644 index 000000000000..bfae221c7483 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.HIPx.out @@ -0,0 +1,21 @@ +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Terry</div> + <div class="text"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Jones</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department">660</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Leslie</div> + <div class="text"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Patterson</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department">341</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Ashley</div> + <div class="text"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Smith</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department">1440</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_06.HP.err b/contrib/libxo/tests/core/saved/test_06.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.HP.err diff --git a/contrib/libxo/tests/core/saved/test_06.HP.out b/contrib/libxo/tests/core/saved/test_06.HP.out new file mode 100644 index 000000000000..f8b072a3c24b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.HP.out @@ -0,0 +1,21 @@ +<div class="line"> + <div class="data" data-tag="first-name">Terry</div> + <div class="text"> </div> + <div class="data" data-tag="last-name">Jones</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department">660</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Leslie</div> + <div class="text"> </div> + <div class="data" data-tag="last-name">Patterson</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department">341</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Ashley</div> + <div class="text"> </div> + <div class="data" data-tag="last-name">Smith</div> + <div class="text"> works in dept #</div> + <div class="data" data-tag="department">1440</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_06.J.err b/contrib/libxo/tests/core/saved/test_06.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.J.err diff --git a/contrib/libxo/tests/core/saved/test_06.J.out b/contrib/libxo/tests/core/saved/test_06.J.out new file mode 100644 index 000000000000..94e01146e735 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.J.out @@ -0,0 +1 @@ +{"employees": {"employee": [{"first-name":"Terry","last-name":"Jones","department":660}, {"first-name":"Leslie","last-name":"Patterson","department":341}, {"first-name":"Ashley","last-name":"Smith","department":1440}]}} diff --git a/contrib/libxo/tests/core/saved/test_06.JP.err b/contrib/libxo/tests/core/saved/test_06.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.JP.err diff --git a/contrib/libxo/tests/core/saved/test_06.JP.out b/contrib/libxo/tests/core/saved/test_06.JP.out new file mode 100644 index 000000000000..ff2d5b033dda --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.JP.out @@ -0,0 +1,21 @@ +{ + "employees": { + "employee": [ + { + "first-name": "Terry", + "last-name": "Jones", + "department": 660 + }, + { + "first-name": "Leslie", + "last-name": "Patterson", + "department": 341 + }, + { + "first-name": "Ashley", + "last-name": "Smith", + "department": 1440 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_06.JPu.err b/contrib/libxo/tests/core/saved/test_06.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_06.JPu.out b/contrib/libxo/tests/core/saved/test_06.JPu.out new file mode 100644 index 000000000000..b0f802dc03fd --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.JPu.out @@ -0,0 +1,21 @@ +{ + "employees": { + "employee": [ + { + "first_name": "Terry", + "last_name": "Jones", + "department": 660 + }, + { + "first_name": "Leslie", + "last_name": "Patterson", + "department": 341 + }, + { + "first_name": "Ashley", + "last_name": "Smith", + "department": 1440 + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_06.T.err b/contrib/libxo/tests/core/saved/test_06.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.T.err diff --git a/contrib/libxo/tests/core/saved/test_06.T.out b/contrib/libxo/tests/core/saved/test_06.T.out new file mode 100644 index 000000000000..da60fb7c9ab3 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.T.out @@ -0,0 +1,3 @@ +Terry Jones works in dept #660 +Leslie Patterson works in dept #341 +Ashley Smith works in dept #1440 diff --git a/contrib/libxo/tests/core/saved/test_06.X.err b/contrib/libxo/tests/core/saved/test_06.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.X.err diff --git a/contrib/libxo/tests/core/saved/test_06.X.out b/contrib/libxo/tests/core/saved/test_06.X.out new file mode 100644 index 000000000000..a626fb6679d9 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.X.out @@ -0,0 +1 @@ +<employees><employee><first-name>Terry</first-name><last-name>Jones</last-name><department>660</department></employee><employee><first-name>Leslie</first-name><last-name>Patterson</last-name><department>341</department></employee><employee><first-name>Ashley</first-name><last-name>Smith</last-name><department>1440</department></employee></employees>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_06.XP.err b/contrib/libxo/tests/core/saved/test_06.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.XP.err diff --git a/contrib/libxo/tests/core/saved/test_06.XP.out b/contrib/libxo/tests/core/saved/test_06.XP.out new file mode 100644 index 000000000000..b6e764180dad --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_06.XP.out @@ -0,0 +1,17 @@ +<employees> + <employee> + <first-name>Terry</first-name> + <last-name>Jones</last-name> + <department>660</department> + </employee> + <employee> + <first-name>Leslie</first-name> + <last-name>Patterson</last-name> + <department>341</department> + </employee> + <employee> + <first-name>Ashley</first-name> + <last-name>Smith</last-name> + <department>1440</department> + </employee> +</employees> diff --git a/contrib/libxo/tests/core/saved/test_07.E.err b/contrib/libxo/tests/core/saved/test_07.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.E.err diff --git a/contrib/libxo/tests/core/saved/test_07.E.out b/contrib/libxo/tests/core/saved/test_07.E.out new file mode 100644 index 000000000000..0504c6b97b02 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.E.out @@ -0,0 +1,76 @@ +op create: [test] [] [0] +op open_container: [employees] [] [0x200010] +op open_list: [test] [] [0] +op open_instance: [test] [] [0x200010] +op string: [filename] [(null)] [0x88] +op close_instance: [test] [] [0] +op close_list: [test] [] [0] +op string: [v1] [γιγνώσκειν] [0] +op string: [v2] [ὦ ἄνδρες ᾿Αθηναῖοι] [0] +op content: [columns] [28] [0] +op content: [columns] [2] [0] +op string: [v1] [ახლავე გაიაროთ რეგისტრაცია] [0] +op string: [v2] [Unicode-ის მეათე საერთაშორისო] [0] +op content: [columns] [55] [0] +op content: [columns] [0] [0] +op open_list: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Jim] [0] +op string: [nic-name] ["რეგტ"] [0] +op string: [last-name] [გთხოვთ ახ] [0] +op content: [department] [431] [0] +op content: [percent-time] [90] [0] +op content: [columns] [23] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Terry] [0] +op string: [nic-name] ["<one"] [0] +op string: [last-name] [Οὐχὶ ταὐτὰ παρίσταταί μοι Jones] [0] +op content: [department] [660] [0] +op content: [percent-time] [90] [0] +op content: [columns] [47] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Leslie] [0] +op string: [nic-name] ["Les"] [0] +op string: [last-name] [Patterson] [0] +op content: [department] [341] [0] +op content: [percent-time] [60] [0] +op content: [columns] [25] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [Ashley] [0] +op string: [nic-name] ["Ash"] [0] +op string: [last-name] [Meter & Smith] [0] +op content: [department] [1440] [0] +op content: [percent-time] [40] [0] +op content: [columns] [30] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [0123456789] [0] +op string: [nic-name] ["0123456789"] [0] +op string: [last-name] [012345678901234567890] [0] +op content: [department] [1440] [0] +op content: [percent-time] [40] [0] +op content: [columns] [49] [0] +op close_instance: [employee] [] [0] +op open_instance: [employee] [] [0x200010] +op string: [first-name] [ახლა] [0] +op string: [nic-name] ["გაიარო"] [0] +op string: [last-name] [საერთაშორისო] [0] +op content: [department] [123] [0] +op content: [percent-time] [90] [0] +op content: [columns] [29] [0] +op attr: [full-time] [honest & for true] [0] +op string: [benefits] [full] [0x8] +op close_instance: [employee] [] [0] +op close_list: [employee] [] [0] +op close_container: [employees] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_07.H.err b/contrib/libxo/tests/core/saved/test_07.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.H.err diff --git a/contrib/libxo/tests/core/saved/test_07.H.out b/contrib/libxo/tests/core/saved/test_07.H.out new file mode 100644 index 000000000000..9fd042b36362 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.H.out @@ -0,0 +1 @@ +<div class="line"><div class="text">Οὐχὶ ταὐτὰ παρίσταταί μοι </div><div class="data" data-tag="v1">γιγνώσκειν</div><div class="text">, </div><div class="data" data-tag="v2">ὦ ἄνδρες ᾿Αθηναῖοι</div></div><div class="line"><div class="data" data-tag="columns">56</div></div><div class="line"><div class="data" data-tag="columns">2</div></div><div class="line"><div class="text">გთხოვთ </div><div class="data" data-tag="v1">ახლავე გაიაროთ რეგისტრაცია</div><div class="text"> </div><div class="data" data-tag="v2">Unicode-ის მეათე საერთაშორისო</div></div><div class="line"><div class="data" data-tag="columns">63</div></div><div class="line"><div class="title">First Name </div><div class="title">Last Name </div><div class="title">Department </div><div class="title">Time (%)</div></div><div class="line"><div class="data" data-tag="columns">59</div></div><div class="line"><div class="data" data-tag="first-name">Jim</div><div class="text"> (</div><div class="data" data-tag="nic-name">"რეგტ"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">გთხოვთ ახ </div><div class="data" data-tag="department"> 431</div><div class="data" data-tag="percent-time"> 90</div></div><div class="line"><div class="data" data-tag="columns">55</div></div><div class="line"><div class="data" data-tag="first-name">Terry</div><div class="text"> (</div><div class="data" data-tag="nic-name">"<one"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">Οὐχὶ ταὐτὰ παρ</div><div class="data" data-tag="department"> 660</div><div class="data" data-tag="percent-time"> 90</div></div><div class="line"><div class="data" data-tag="columns">55</div></div><div class="line"><div class="data" data-tag="first-name">Leslie</div><div class="text"> (</div><div class="data" data-tag="nic-name">"Les"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">Patterson </div><div class="data" data-tag="department"> 341</div><div class="data" data-tag="percent-time"> 60</div></div><div class="line"><div class="data" data-tag="columns">55</div></div><div class="line"><div class="data" data-tag="first-name">Ashley</div><div class="text"> (</div><div class="data" data-tag="nic-name">"Ash"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">Meter & Smith </div><div class="data" data-tag="department"> 1440</div><div class="data" data-tag="percent-time"> 40</div></div><div class="line"><div class="data" data-tag="columns">55</div></div><div class="line"><div class="data" data-tag="first-name">0123456789</div><div class="text"> (</div><div class="data" data-tag="nic-name">"0123456789"</div><div class="text">)</div><div class="data" data-tag="last-name">01234567890123</div><div class="data" data-tag="department"> 1440</div><div class="data" data-tag="percent-time"> 40</div></div><div class="line"><div class="data" data-tag="columns">55</div></div><div class="line"><div class="data" data-tag="first-name">ახლა</div><div class="text"> (</div><div class="data" data-tag="nic-name">"გაიარო"</div><div class="text">)</div><div class="padding"> </div><div class="data" data-tag="last-name">საერთაშორისო </div><div class="data" data-tag="department"> 123</div><div class="data" data-tag="percent-time"> 90</div></div><div class="line"><div class="data" data-tag="columns">55</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_07.HIPx.err b/contrib/libxo/tests/core/saved/test_07.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_07.HIPx.out b/contrib/libxo/tests/core/saved/test_07.HIPx.out new file mode 100644 index 000000000000..197c475ddd48 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.HIPx.out @@ -0,0 +1,107 @@ +<div class="line"> + <div class="text">Οὐχὶ ταὐτὰ παρίσταταί μοι </div> + <div class="data" data-tag="v1" data-xpath="/employees/v1">γιγνώσκειν</div> + <div class="text">, </div> + <div class="data" data-tag="v2" data-xpath="/employees/v2">ὦ ἄνδρες ᾿Αθηναῖοι</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/columns">56</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/columns">2</div> +</div> +<div class="line"> + <div class="text">გთხოვთ </div> + <div class="data" data-tag="v1" data-xpath="/employees/v1">ახლავე გაიაროთ რეგისტრაცია</div> + <div class="text"> </div> + <div class="data" data-tag="v2" data-xpath="/employees/v2">Unicode-ის მეათე საერთაშორისო</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/columns">63</div> +</div> +<div class="line"> + <div class="title">First Name </div> + <div class="title">Last Name </div> + <div class="title">Department </div> + <div class="title">Time (%)</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/columns">59</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Jim</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"რეგტ"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">გთხოვთ ახ </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 431</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/employee/columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Terry</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"<one"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Οὐχὶ ταὐτὰ παρ</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 660</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/employee/columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Leslie</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"Les"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Patterson </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 341</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 60</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/employee/columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">Ashley</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"Ash"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">Meter & Smith </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 1440</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/employee/columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">0123456789</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"0123456789"</div> + <div class="text">)</div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">01234567890123</div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 1440</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/employee/columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name" data-xpath="/employees/employee/first-name" data-type="string" data-help="First name of employee">ახლა</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name" data-xpath="/employees/employee/nic-name">"გაიარო"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name" data-xpath="/employees/employee/last-name" data-type="string" data-help="Last name of employee">საერთაშორისო </div> + <div class="data" data-tag="department" data-xpath="/employees/employee/department"> 123</div> + <div class="data" data-tag="percent-time" data-xpath="/employees/employee/percent-time" data-type="number" data-help="Percentage of full & part time (%)"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="columns" data-xpath="/employees/employee/columns">55</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_07.HP.err b/contrib/libxo/tests/core/saved/test_07.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.HP.err diff --git a/contrib/libxo/tests/core/saved/test_07.HP.out b/contrib/libxo/tests/core/saved/test_07.HP.out new file mode 100644 index 000000000000..a5ce61d65113 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.HP.out @@ -0,0 +1,107 @@ +<div class="line"> + <div class="text">Οὐχὶ ταὐτὰ παρίσταταί μοι </div> + <div class="data" data-tag="v1">γιγνώσκειν</div> + <div class="text">, </div> + <div class="data" data-tag="v2">ὦ ἄνδρες ᾿Αθηναῖοι</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">56</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">2</div> +</div> +<div class="line"> + <div class="text">გთხოვთ </div> + <div class="data" data-tag="v1">ახლავე გაიაროთ რეგისტრაცია</div> + <div class="text"> </div> + <div class="data" data-tag="v2">Unicode-ის მეათე საერთაშორისო</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">63</div> +</div> +<div class="line"> + <div class="title">First Name </div> + <div class="title">Last Name </div> + <div class="title">Department </div> + <div class="title">Time (%)</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">59</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Jim</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"რეგტ"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">გთხოვთ ახ </div> + <div class="data" data-tag="department"> 431</div> + <div class="data" data-tag="percent-time"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Terry</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"<one"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">Οὐχὶ ταὐτὰ παρ</div> + <div class="data" data-tag="department"> 660</div> + <div class="data" data-tag="percent-time"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Leslie</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"Les"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">Patterson </div> + <div class="data" data-tag="department"> 341</div> + <div class="data" data-tag="percent-time"> 60</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">Ashley</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"Ash"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">Meter & Smith </div> + <div class="data" data-tag="department"> 1440</div> + <div class="data" data-tag="percent-time"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">0123456789</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"0123456789"</div> + <div class="text">)</div> + <div class="data" data-tag="last-name">01234567890123</div> + <div class="data" data-tag="department"> 1440</div> + <div class="data" data-tag="percent-time"> 40</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">55</div> +</div> +<div class="line"> + <div class="data" data-tag="first-name">ახლა</div> + <div class="text"> (</div> + <div class="data" data-tag="nic-name">"გაიარო"</div> + <div class="text">)</div> + <div class="padding"> </div> + <div class="data" data-tag="last-name">საერთაშორისო </div> + <div class="data" data-tag="department"> 123</div> + <div class="data" data-tag="percent-time"> 90</div> +</div> +<div class="line"> + <div class="data" data-tag="columns">55</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_07.J.err b/contrib/libxo/tests/core/saved/test_07.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.J.err diff --git a/contrib/libxo/tests/core/saved/test_07.J.out b/contrib/libxo/tests/core/saved/test_07.J.out new file mode 100644 index 000000000000..bef0fea986e9 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.J.out @@ -0,0 +1 @@ +{"employees": {"test": [{"filename":"(null)"}],"v1":"γιγνώσκειν","v2":"ὦ ἄνδρες ᾿Αθηναῖοι","columns":28,"columns":2,"v1":"ახლავე გაიაროთ რეგისტრაცია","v2":"Unicode-ის მეათე საერთაშორისო","columns":55,"columns":0, "employee": [{"first-name":"Jim","nic-name":"\"რეგტ\"","last-name":"გთხოვთ ახ","department":431,"percent-time":90,"columns":23,"benefits":"full"}, {"first-name":"Terry","nic-name":"\"<one\"","last-name":"Οὐχὶ ταὐτὰ παρίσταταί μοι Jones","department":660,"percent-time":90,"columns":47,"benefits":"full"}, {"first-name":"Leslie","nic-name":"\"Les\"","last-name":"Patterson","department":341,"percent-time":60,"columns":25,"benefits":"full"}, {"first-name":"Ashley","nic-name":"\"Ash\"","last-name":"Meter & Smith","department":1440,"percent-time":40,"columns":30}, {"first-name":"0123456789","nic-name":"\"0123456789\"","last-name":"012345678901234567890","department":1440,"percent-time":40,"columns":49}, {"first-name":"ახლა","nic-name":"\"გაიარო\"","last-name":"საერთაშორისო","department":123,"percent-time":90,"columns":29,"benefits":"full"}]}} diff --git a/contrib/libxo/tests/core/saved/test_07.JP.err b/contrib/libxo/tests/core/saved/test_07.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.JP.err diff --git a/contrib/libxo/tests/core/saved/test_07.JP.out b/contrib/libxo/tests/core/saved/test_07.JP.out new file mode 100644 index 000000000000..9c969f976894 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.JP.out @@ -0,0 +1,71 @@ +{ + "employees": { + "test": [ + { + "filename": "(null)" + } + ], + "v1": "γιγνώσκειν", + "v2": "ὦ ἄνδρες ᾿Αθηναῖοι", + "columns": 28, + "columns": 2, + "v1": "ახლავე გაიაროთ რეგისტრაცია", + "v2": "Unicode-ის მეათე საერთაშორისო", + "columns": 55, + "columns": 0, + "employee": [ + { + "first-name": "Jim", + "nic-name": "\"რეგტ\"", + "last-name": "გთხოვთ ახ", + "department": 431, + "percent-time": 90, + "columns": 23, + "benefits": "full" + }, + { + "first-name": "Terry", + "nic-name": "\"<one\"", + "last-name": "Οὐχὶ ταὐτὰ παρίσταταί μοι Jones", + "department": 660, + "percent-time": 90, + "columns": 47, + "benefits": "full" + }, + { + "first-name": "Leslie", + "nic-name": "\"Les\"", + "last-name": "Patterson", + "department": 341, + "percent-time": 60, + "columns": 25, + "benefits": "full" + }, + { + "first-name": "Ashley", + "nic-name": "\"Ash\"", + "last-name": "Meter & Smith", + "department": 1440, + "percent-time": 40, + "columns": 30 + }, + { + "first-name": "0123456789", + "nic-name": "\"0123456789\"", + "last-name": "012345678901234567890", + "department": 1440, + "percent-time": 40, + "columns": 49 + }, + { + "first-name": "ახლა", + "nic-name": "\"გაიარო\"", + "last-name": "საერთაშორისო", + "department": 123, + "percent-time": 90, + "columns": 29, + "benefits": "full" + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_07.JPu.err b/contrib/libxo/tests/core/saved/test_07.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_07.JPu.out b/contrib/libxo/tests/core/saved/test_07.JPu.out new file mode 100644 index 000000000000..c33bb26eea03 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.JPu.out @@ -0,0 +1,71 @@ +{ + "employees": { + "test": [ + { + "filename": "(null)" + } + ], + "v1": "γιγνώσκειν", + "v2": "ὦ ἄνδρες ᾿Αθηναῖοι", + "columns": 28, + "columns": 2, + "v1": "ახლავე გაიაროთ რეგისტრაცია", + "v2": "Unicode-ის მეათე საერთაშორისო", + "columns": 55, + "columns": 0, + "employee": [ + { + "first_name": "Jim", + "nic_name": "\"რეგტ\"", + "last_name": "გთხოვთ ახ", + "department": 431, + "percent_time": 90, + "columns": 23, + "benefits": "full" + }, + { + "first_name": "Terry", + "nic_name": "\"<one\"", + "last_name": "Οὐχὶ ταὐτὰ παρίσταταί μοι Jones", + "department": 660, + "percent_time": 90, + "columns": 47, + "benefits": "full" + }, + { + "first_name": "Leslie", + "nic_name": "\"Les\"", + "last_name": "Patterson", + "department": 341, + "percent_time": 60, + "columns": 25, + "benefits": "full" + }, + { + "first_name": "Ashley", + "nic_name": "\"Ash\"", + "last_name": "Meter & Smith", + "department": 1440, + "percent_time": 40, + "columns": 30 + }, + { + "first_name": "0123456789", + "nic_name": "\"0123456789\"", + "last_name": "012345678901234567890", + "department": 1440, + "percent_time": 40, + "columns": 49 + }, + { + "first_name": "ახლა", + "nic_name": "\"გაიარო\"", + "last_name": "საერთაშორისო", + "department": 123, + "percent_time": 90, + "columns": 29, + "benefits": "full" + } + ] + } +} diff --git a/contrib/libxo/tests/core/saved/test_07.T.err b/contrib/libxo/tests/core/saved/test_07.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.T.err diff --git a/contrib/libxo/tests/core/saved/test_07.T.out b/contrib/libxo/tests/core/saved/test_07.T.out new file mode 100644 index 000000000000..5f4ff5c09f30 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.T.out @@ -0,0 +1,19 @@ +Οὐχὶ ταὐτὰ παρίσταταί μοι γιγνώσκειν, ὦ ἄνδρες ᾿Αθηναῖοι +56 +2 +გთხოვთ ახლავე გაიაროთ რეგისტრაცია Unicode-ის მეათე საერთაშორისო +63 +First Name Last Name Department Time (%) +59 +Jim ("რეგტ") გთხოვთ ახ 431 90 +55 +Terry ("<one") Οὐχὶ ταὐτὰ παρ 660 90 +55 +Leslie ("Les") Patterson 341 60 +55 +Ashley ("Ash") Meter & Smith 1440 40 +55 +0123456789 ("0123456789")01234567890123 1440 40 +55 +ახლა ("გაიარო") საერთაშორისო 123 90 +55 diff --git a/contrib/libxo/tests/core/saved/test_07.X.err b/contrib/libxo/tests/core/saved/test_07.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.X.err diff --git a/contrib/libxo/tests/core/saved/test_07.X.out b/contrib/libxo/tests/core/saved/test_07.X.out new file mode 100644 index 000000000000..bc8d22b7dafd --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.X.out @@ -0,0 +1 @@ +<employees><test><filename>(null)</filename></test><v1>γιγνώσκειν</v1><v2>ὦ ἄνδρες ᾿Αθηναῖοι</v2><columns>28</columns><columns>2</columns><v1>ახლავე გაიაროთ რეგისტრაცია</v1><v2>Unicode-ის მეათე საერთაშორისო</v2><columns>55</columns><columns>0</columns><employee><first-name>Jim</first-name><nic-name>"რეგტ"</nic-name><last-name>გთხოვთ ახ</last-name><department>431</department><percent-time>90</percent-time><columns>23</columns><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>Terry</first-name><nic-name>"<one"</nic-name><last-name>Οὐχὶ ταὐτὰ παρίσταταί μοι Jones</last-name><department>660</department><percent-time>90</percent-time><columns>47</columns><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>Leslie</first-name><nic-name>"Les"</nic-name><last-name>Patterson</last-name><department>341</department><percent-time>60</percent-time><columns>25</columns><benefits full-time="honest & for true">full</benefits></employee><employee><first-name>Ashley</first-name><nic-name>"Ash"</nic-name><last-name>Meter & Smith</last-name><department>1440</department><percent-time>40</percent-time><columns>30</columns></employee><employee><first-name>0123456789</first-name><nic-name>"0123456789"</nic-name><last-name>012345678901234567890</last-name><department>1440</department><percent-time>40</percent-time><columns>49</columns></employee><employee><first-name>ახლა</first-name><nic-name>"გაიარო"</nic-name><last-name>საერთაშორისო</last-name><department>123</department><percent-time>90</percent-time><columns>29</columns><benefits full-time="honest & for true">full</benefits></employee></employees>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_07.XP.err b/contrib/libxo/tests/core/saved/test_07.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.XP.err diff --git a/contrib/libxo/tests/core/saved/test_07.XP.out b/contrib/libxo/tests/core/saved/test_07.XP.out new file mode 100644 index 000000000000..c13f838c85f4 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_07.XP.out @@ -0,0 +1,65 @@ +<employees> + <test> + <filename>(null)</filename> + </test> + <v1>γιγνώσκειν</v1> + <v2>ὦ ἄνδρες ᾿Αθηναῖοι</v2> + <columns>28</columns> + <columns>2</columns> + <v1>ახლავე გაიაროთ რეგისტრაცია</v1> + <v2>Unicode-ის მეათე საერთაშორისო</v2> + <columns>55</columns> + <columns>0</columns> + <employee> + <first-name>Jim</first-name> + <nic-name>"რეგტ"</nic-name> + <last-name>გთხოვთ ახ</last-name> + <department>431</department> + <percent-time>90</percent-time> + <columns>23</columns> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>Terry</first-name> + <nic-name>"<one"</nic-name> + <last-name>Οὐχὶ ταὐτὰ παρίσταταί μοι Jones</last-name> + <department>660</department> + <percent-time>90</percent-time> + <columns>47</columns> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>Leslie</first-name> + <nic-name>"Les"</nic-name> + <last-name>Patterson</last-name> + <department>341</department> + <percent-time>60</percent-time> + <columns>25</columns> + <benefits full-time="honest & for true">full</benefits> + </employee> + <employee> + <first-name>Ashley</first-name> + <nic-name>"Ash"</nic-name> + <last-name>Meter & Smith</last-name> + <department>1440</department> + <percent-time>40</percent-time> + <columns>30</columns> + </employee> + <employee> + <first-name>0123456789</first-name> + <nic-name>"0123456789"</nic-name> + <last-name>012345678901234567890</last-name> + <department>1440</department> + <percent-time>40</percent-time> + <columns>49</columns> + </employee> + <employee> + <first-name>ახლა</first-name> + <nic-name>"გაიარო"</nic-name> + <last-name>საერთაშორისო</last-name> + <department>123</department> + <percent-time>90</percent-time> + <columns>29</columns> + <benefits full-time="honest & for true">full</benefits> + </employee> +</employees> diff --git a/contrib/libxo/tests/core/saved/test_08.E.err b/contrib/libxo/tests/core/saved/test_08.E.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.E.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.E.out b/contrib/libxo/tests/core/saved/test_08.E.out new file mode 100644 index 000000000000..11248e8f62e0 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.E.out @@ -0,0 +1,186 @@ +op create: [test] [] [0] +op open_container: [top] [] [0x810] +op open_container: [data] [] [0x810] +op open_container: [contents] [] [0x810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [gum] [0x80] +op content: [count] [1412] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [rope] [0x80] +op content: [count] [85] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [ladder] [0x80] +op content: [count] [0] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [bolt] [0x80] +op content: [count] [4123] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [water] [0x80] +op content: [count] [17] [0x20] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [contents] [] [0] +op close_container: [data] [] [0] +op open_container: [data2] [] [0x810] +op open_container: [contents] [] [0x810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [gum] [0x80] +op content: [count] [1412] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [rope] [0x80] +op content: [count] [85] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [ladder] [0x80] +op content: [count] [0] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [bolt] [0x80] +op content: [count] [4123] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [water] [0x80] +op content: [count] [17] [0x20] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [contents] [] [0] +op close_container: [data2] [] [0] +op open_container: [data3] [] [0x810] +op open_container: [contents] [] [0x810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [gum] [0x80] +op content: [count] [1412] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [rope] [0x80] +op content: [count] [85] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [ladder] [0x80] +op content: [count] [0] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [bolt] [0x80] +op content: [count] [4123] [0x20] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [water] [0x80] +op content: [count] [17] [0x20] +op string: [test] [one] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [contents] [] [0] +op close_container: [data3] [] [0] +op open_container: [data4] [] [0x810] +op open_container: [contents] [] [0x810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [gum] [0x80] +op content: [count] [1412] [0x20] +op open_list: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [0] [0] +op content: [next] [1] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [1] [0] +op content: [next] [2] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [2] [0] +op content: [next] [3] [0] +op close_instance: [sub] [] [0] +op close_list: [sub] [] [0] +op content: [last] [3] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [rope] [0x80] +op content: [count] [85] [0x20] +op open_list: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [0] [0] +op content: [next] [1] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [1] [0] +op content: [next] [2] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [2] [0] +op content: [next] [3] [0] +op close_instance: [sub] [] [0] +op close_list: [sub] [] [0] +op content: [last] [3] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [ladder] [0x80] +op content: [count] [0] [0x20] +op open_list: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [0] [0] +op content: [next] [1] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [1] [0] +op content: [next] [2] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [2] [0] +op content: [next] [3] [0] +op close_instance: [sub] [] [0] +op close_list: [sub] [] [0] +op content: [last] [3] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [bolt] [0x80] +op content: [count] [4123] [0x20] +op open_list: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [0] [0] +op content: [next] [1] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [1] [0] +op content: [next] [2] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [2] [0] +op content: [next] [3] [0] +op close_instance: [sub] [] [0] +op close_list: [sub] [] [0] +op content: [last] [3] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x810] +op string: [name] [water] [0x80] +op content: [count] [17] [0x20] +op open_list: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [0] [0] +op content: [next] [1] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [1] [0] +op content: [next] [2] [0] +op close_instance: [sub] [] [0] +op open_instance: [sub] [] [0x810] +op content: [name] [2] [0] +op content: [next] [3] [0] +op close_instance: [sub] [] [0] +op close_list: [sub] [] [0] +op content: [last] [3] [0] +op string: [test] [one] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [contents] [] [0] +op close_container: [data4] [] [0] +op close_container: [top] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_08.H.err b/contrib/libxo/tests/core/saved/test_08.H.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.H.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.H.out b/contrib/libxo/tests/core/saved/test_08.H.out new file mode 100644 index 000000000000..81f12d8412fd --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.H.out @@ -0,0 +1 @@ +<div class="line"><div class="title">Item </div><div class="title"> Count</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="count"> 1412</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="count"> 85</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="count"> 0</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="count"> 4123</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="count"> 17</div></div><div class="line"></div><div class="line"></div><div class="line"><div class="title">Item </div><div class="title"> Count</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="count"> 1412</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="count"> 85</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="count"> 0</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="count"> 4123</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="count"> 17</div></div><div class="line"></div><div class="line"></div><div class="line"><div class="title">Item </div><div class="title"> Count</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="count"> 1412</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="count"> 85</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="count"> 0</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="count"> 4123</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="count"> 17</div></div><div class="line"><div class="data" data-tag="test">one</div></div><div class="line"></div><div class="line"><div class="title">Item </div><div class="title"> Count</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="count"> 1412</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">0</div><div class="text"> + 1 = </div><div class="data" data-tag="next">1</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">1</div><div class="text"> + 1 = </div><div class="data" data-tag="next">2</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">2</div><div class="text"> + 1 = </div><div class="data" data-tag="next">3</div></div><div class="line"><div class="label">Last</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="last">3</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="count"> 85</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">0</div><div class="text"> + 1 = </div><div class="data" data-tag="next">1</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">1</div><div class="text"> + 1 = </div><div class="data" data-tag="next">2</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">2</div><div class="text"> + 1 = </div><div class="data" data-tag="next">3</div></div><div class="line"><div class="label">Last</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="last">3</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="count"> 0</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">0</div><div class="text"> + 1 = </div><div class="data" data-tag="next">1</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">1</div><div class="text"> + 1 = </div><div class="data" data-tag="next">2</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">2</div><div class="text"> + 1 = </div><div class="data" data-tag="next">3</div></div><div class="line"><div class="label">Last</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="last">3</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="count"> 4123</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">0</div><div class="text"> + 1 = </div><div class="data" data-tag="next">1</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">1</div><div class="text"> + 1 = </div><div class="data" data-tag="next">2</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">2</div><div class="text"> + 1 = </div><div class="data" data-tag="next">3</div></div><div class="line"><div class="label">Last</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="last">3</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="count"> 17</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">0</div><div class="text"> + 1 = </div><div class="data" data-tag="next">1</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">1</div><div class="text"> + 1 = </div><div class="data" data-tag="next">2</div></div><div class="line"><div class="label">Name</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="name">2</div><div class="text"> + 1 = </div><div class="data" data-tag="next">3</div></div><div class="line"><div class="label">Last</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="last">3</div></div><div class="line"><div class="data" data-tag="test">one</div></div><div class="line"></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_08.HIPx.err b/contrib/libxo/tests/core/saved/test_08.HIPx.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.HIPx.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.HIPx.out b/contrib/libxo/tests/core/saved/test_08.HIPx.out new file mode 100644 index 000000000000..2263347ca5cd --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.HIPx.out @@ -0,0 +1,264 @@ +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/contents/item/name" data-key="key">gum </div> + <div class="data" data-tag="count" data-xpath="/top/data/contents/item[name = 'gum']/count"> 1412</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/contents/item/name" data-key="key">rope </div> + <div class="data" data-tag="count" data-xpath="/top/data/contents/item[name = 'rope']/count"> 85</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/contents/item/name" data-key="key">ladder </div> + <div class="data" data-tag="count" data-xpath="/top/data/contents/item[name = 'ladder']/count"> 0</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/contents/item/name" data-key="key">bolt </div> + <div class="data" data-tag="count" data-xpath="/top/data/contents/item[name = 'bolt']/count"> 4123</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/contents/item/name" data-key="key">water </div> + <div class="data" data-tag="count" data-xpath="/top/data/contents/item[name = 'water']/count"> 17</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data2/contents/item/name" data-key="key">gum </div> + <div class="data" data-tag="count" data-xpath="/top/data2/contents/item[name = 'gum']/count"> 1412</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data2/contents/item/name" data-key="key">rope </div> + <div class="data" data-tag="count" data-xpath="/top/data2/contents/item[name = 'rope']/count"> 85</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data2/contents/item/name" data-key="key">ladder </div> + <div class="data" data-tag="count" data-xpath="/top/data2/contents/item[name = 'ladder']/count"> 0</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data2/contents/item/name" data-key="key">bolt </div> + <div class="data" data-tag="count" data-xpath="/top/data2/contents/item[name = 'bolt']/count"> 4123</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data2/contents/item/name" data-key="key">water </div> + <div class="data" data-tag="count" data-xpath="/top/data2/contents/item[name = 'water']/count"> 17</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data3/m1/contents/item/name" data-key="key">gum </div> + <div class="data" data-tag="count" data-xpath="/top/data3/m1/contents/item[name = 'gum']/count"> 1412</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data3/m1/contents/item/name" data-key="key">rope </div> + <div class="data" data-tag="count" data-xpath="/top/data3/m1/contents/item[name = 'rope']/count"> 85</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data3/m1/contents/item/name" data-key="key">ladder </div> + <div class="data" data-tag="count" data-xpath="/top/data3/m1/contents/item[name = 'ladder']/count"> 0</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data3/m1/contents/item/name" data-key="key">bolt </div> + <div class="data" data-tag="count" data-xpath="/top/data3/m1/contents/item[name = 'bolt']/count"> 4123</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data3/m1/contents/item/name" data-key="key">water </div> + <div class="data" data-tag="count" data-xpath="/top/data3/m1/contents/item[name = 'water']/count"> 17</div> +</div> +<div class="line"> + <div class="data" data-tag="test" data-xpath="/top/data3/m1/contents/item[name = 'water']/test">one</div> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item/name" data-key="key">gum </div> + <div class="data" data-tag="count" data-xpath="/top/data4/m1/contents/item[name = 'gum']/count"> 1412</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'gum']/m2/sub/name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'gum']/m2/sub/next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'gum']/m2/sub/name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'gum']/m2/sub/next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'gum']/m2/sub/name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'gum']/m2/sub/next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last" data-xpath="/top/data4/m1/contents/item[name = 'gum']/last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item/name" data-key="key">rope </div> + <div class="data" data-tag="count" data-xpath="/top/data4/m1/contents/item[name = 'rope']/count"> 85</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'rope']/m2/sub/name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'rope']/m2/sub/next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'rope']/m2/sub/name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'rope']/m2/sub/next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'rope']/m2/sub/name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'rope']/m2/sub/next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last" data-xpath="/top/data4/m1/contents/item[name = 'rope']/last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item/name" data-key="key">ladder </div> + <div class="data" data-tag="count" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/count"> 0</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/m2/sub/name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/m2/sub/next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/m2/sub/name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/m2/sub/next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/m2/sub/name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/m2/sub/next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last" data-xpath="/top/data4/m1/contents/item[name = 'ladder']/last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item/name" data-key="key">bolt </div> + <div class="data" data-tag="count" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/count"> 4123</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/m2/sub/name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/m2/sub/next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/m2/sub/name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/m2/sub/next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/m2/sub/name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/m2/sub/next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last" data-xpath="/top/data4/m1/contents/item[name = 'bolt']/last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item/name" data-key="key">water </div> + <div class="data" data-tag="count" data-xpath="/top/data4/m1/contents/item[name = 'water']/count"> 17</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'water']/m2/sub/name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'water']/m2/sub/next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'water']/m2/sub/name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'water']/m2/sub/next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name" data-xpath="/top/data4/m1/contents/item[name = 'water']/m2/sub/name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next" data-xpath="/top/data4/m1/contents/item[name = 'water']/m2/sub/next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last" data-xpath="/top/data4/m1/contents/item[name = 'water']/last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="test" data-xpath="/top/data4/m1/contents/item[name = 'water']/test">one</div> +</div> +<div class="line"> +</div> diff --git a/contrib/libxo/tests/core/saved/test_08.HP.err b/contrib/libxo/tests/core/saved/test_08.HP.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.HP.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.HP.out b/contrib/libxo/tests/core/saved/test_08.HP.out new file mode 100644 index 000000000000..3524f5e9fac1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.HP.out @@ -0,0 +1,264 @@ +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="count"> 1412</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="count"> 85</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="count"> 0</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="count"> 4123</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="count"> 17</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="count"> 1412</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="count"> 85</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="count"> 0</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="count"> 4123</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="count"> 17</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="count"> 1412</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="count"> 85</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="count"> 0</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="count"> 4123</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="count"> 17</div> +</div> +<div class="line"> + <div class="data" data-tag="test">one</div> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="count"> 1412</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="count"> 85</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="count"> 0</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="count"> 4123</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="count"> 17</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">0</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">1</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">1</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">2</div> +</div> +<div class="line"> + <div class="label">Name</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="name">2</div> + <div class="text"> + 1 = </div> + <div class="data" data-tag="next">3</div> +</div> +<div class="line"> + <div class="label">Last</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="last">3</div> +</div> +<div class="line"> + <div class="data" data-tag="test">one</div> +</div> +<div class="line"> +</div> diff --git a/contrib/libxo/tests/core/saved/test_08.J.err b/contrib/libxo/tests/core/saved/test_08.J.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.J.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.J.out b/contrib/libxo/tests/core/saved/test_08.J.out new file mode 100644 index 000000000000..7cb5eb895ab7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.J.out @@ -0,0 +1 @@ +{"top": {"data": {"contents": {"item": [{"name":"gum","count":1412}, {"name":"rope","count":85}, {"name":"ladder","count":0}, {"name":"bolt","count":4123}, {"name":"water","count":17}]}}, "data2": {"contents": {"item": [{"name":"gum","count":1412}, {"name":"rope","count":85}, {"name":"ladder","count":0}, {"name":"bolt","count":4123}, {"name":"water","count":17}]}}, "data3": {"contents": {"item": [{"name":"gum","count":1412}, {"name":"rope","count":85}, {"name":"ladder","count":0}, {"name":"bolt","count":4123}, {"name":"water","count":17,"test":"one"}]}}, "data4": {"contents": {"item": [{"name":"gum","count":1412, "sub": [{"name":0,"next":1}, {"name":1,"next":2}, {"name":2,"next":3}],"last":3}, {"name":"rope","count":85, "sub": [{"name":0,"next":1}, {"name":1,"next":2}, {"name":2,"next":3}],"last":3}, {"name":"ladder","count":0, "sub": [{"name":0,"next":1}, {"name":1,"next":2}, {"name":2,"next":3}],"last":3}, {"name":"bolt","count":4123, "sub": [{"name":0,"next":1}, {"name":1,"next":2}, {"name":2,"next":3}],"last":3}, {"name":"water","count":17, "sub": [{"name":0,"next":1}, {"name":1,"next":2}, {"name":2,"next":3}],"last":3,"test":"one"}]}}}} diff --git a/contrib/libxo/tests/core/saved/test_08.JP.err b/contrib/libxo/tests/core/saved/test_08.JP.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.JP.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.JP.out b/contrib/libxo/tests/core/saved/test_08.JP.out new file mode 100644 index 000000000000..46f3de5ff6c5 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.JP.out @@ -0,0 +1,185 @@ +{ + "top": { + "data": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412 + }, + { + "name": "rope", + "count": 85 + }, + { + "name": "ladder", + "count": 0 + }, + { + "name": "bolt", + "count": 4123 + }, + { + "name": "water", + "count": 17 + } + ] + } + }, + "data2": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412 + }, + { + "name": "rope", + "count": 85 + }, + { + "name": "ladder", + "count": 0 + }, + { + "name": "bolt", + "count": 4123 + }, + { + "name": "water", + "count": 17 + } + ] + } + }, + "data3": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412 + }, + { + "name": "rope", + "count": 85 + }, + { + "name": "ladder", + "count": 0 + }, + { + "name": "bolt", + "count": 4123 + }, + { + "name": "water", + "count": 17, + "test": "one" + } + ] + } + }, + "data4": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "rope", + "count": 85, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "ladder", + "count": 0, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "bolt", + "count": 4123, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "water", + "count": 17, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3, + "test": "one" + } + ] + } + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_08.JPu.err b/contrib/libxo/tests/core/saved/test_08.JPu.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.JPu.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.JPu.out b/contrib/libxo/tests/core/saved/test_08.JPu.out new file mode 100644 index 000000000000..46f3de5ff6c5 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.JPu.out @@ -0,0 +1,185 @@ +{ + "top": { + "data": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412 + }, + { + "name": "rope", + "count": 85 + }, + { + "name": "ladder", + "count": 0 + }, + { + "name": "bolt", + "count": 4123 + }, + { + "name": "water", + "count": 17 + } + ] + } + }, + "data2": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412 + }, + { + "name": "rope", + "count": 85 + }, + { + "name": "ladder", + "count": 0 + }, + { + "name": "bolt", + "count": 4123 + }, + { + "name": "water", + "count": 17 + } + ] + } + }, + "data3": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412 + }, + { + "name": "rope", + "count": 85 + }, + { + "name": "ladder", + "count": 0 + }, + { + "name": "bolt", + "count": 4123 + }, + { + "name": "water", + "count": 17, + "test": "one" + } + ] + } + }, + "data4": { + "contents": { + "item": [ + { + "name": "gum", + "count": 1412, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "rope", + "count": 85, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "ladder", + "count": 0, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "bolt", + "count": 4123, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3 + }, + { + "name": "water", + "count": 17, + "sub": [ + { + "name": 0, + "next": 1 + }, + { + "name": 1, + "next": 2 + }, + { + "name": 2, + "next": 3 + } + ], + "last": 3, + "test": "one" + } + ] + } + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_08.T.err b/contrib/libxo/tests/core/saved/test_08.T.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.T.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.T.out b/contrib/libxo/tests/core/saved/test_08.T.out new file mode 100644 index 000000000000..8923b93642a8 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.T.out @@ -0,0 +1,52 @@ +Item Count +gum 1412 +rope 85 +ladder 0 +bolt 4123 +water 17 + + +Item Count +gum 1412 +rope 85 +ladder 0 +bolt 4123 +water 17 + + +Item Count +gum 1412 +rope 85 +ladder 0 +bolt 4123 +water 17 +one + +Item Count +gum 1412 +Name: 0 + 1 = 1 +Name: 1 + 1 = 2 +Name: 2 + 1 = 3 +Last: 3 +rope 85 +Name: 0 + 1 = 1 +Name: 1 + 1 = 2 +Name: 2 + 1 = 3 +Last: 3 +ladder 0 +Name: 0 + 1 = 1 +Name: 1 + 1 = 2 +Name: 2 + 1 = 3 +Last: 3 +bolt 4123 +Name: 0 + 1 = 1 +Name: 1 + 1 = 2 +Name: 2 + 1 = 3 +Last: 3 +water 17 +Name: 0 + 1 = 1 +Name: 1 + 1 = 2 +Name: 2 + 1 = 3 +Last: 3 +one + diff --git a/contrib/libxo/tests/core/saved/test_08.X.err b/contrib/libxo/tests/core/saved/test_08.X.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.X.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.X.out b/contrib/libxo/tests/core/saved/test_08.X.out new file mode 100644 index 000000000000..b8ee3921af94 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.X.out @@ -0,0 +1 @@ +<top><data><contents><item><name key="key">gum</name><count>1412</count></item><item><name key="key">rope</name><count>85</count></item><item><name key="key">ladder</name><count>0</count></item><item><name key="key">bolt</name><count>4123</count></item><item><name key="key">water</name><count>17</count></item></contents></data><data2><contents><item><name key="key">gum</name><count>1412</count></item><item><name key="key">rope</name><count>85</count></item><item><name key="key">ladder</name><count>0</count></item><item><name key="key">bolt</name><count>4123</count></item><item><name key="key">water</name><count>17</count></item></contents></data2><data3><contents><item><name key="key">gum</name><count>1412</count></item><item><name key="key">rope</name><count>85</count></item><item><name key="key">ladder</name><count>0</count></item><item><name key="key">bolt</name><count>4123</count></item><item><name key="key">water</name><count>17</count><test>one</test></item></contents></data3><data4><contents><item><name key="key">gum</name><count>1412</count><sub><name>0</name><next>1</next></sub><sub><name>1</name><next>2</next></sub><sub><name>2</name><next>3</next></sub><last>3</last></item><item><name key="key">rope</name><count>85</count><sub><name>0</name><next>1</next></sub><sub><name>1</name><next>2</next></sub><sub><name>2</name><next>3</next></sub><last>3</last></item><item><name key="key">ladder</name><count>0</count><sub><name>0</name><next>1</next></sub><sub><name>1</name><next>2</next></sub><sub><name>2</name><next>3</next></sub><last>3</last></item><item><name key="key">bolt</name><count>4123</count><sub><name>0</name><next>1</next></sub><sub><name>1</name><next>2</next></sub><sub><name>2</name><next>3</next></sub><last>3</last></item><item><name key="key">water</name><count>17</count><sub><name>0</name><next>1</next></sub><sub><name>1</name><next>2</next></sub><sub><name>2</name><next>3</next></sub><last>3</last><test>one</test></item></contents></data4></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_08.XP.err b/contrib/libxo/tests/core/saved/test_08.XP.err new file mode 100644 index 000000000000..011858cd30d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.XP.err @@ -0,0 +1,18 @@ +test: close (xo_close_container) fails at marker 'm1'; not found 'data3' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm2'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'data4' +test: close (xo_close_container) fails at marker 'm1'; not found 'top' diff --git a/contrib/libxo/tests/core/saved/test_08.XP.out b/contrib/libxo/tests/core/saved/test_08.XP.out new file mode 100644 index 000000000000..1d9b70f85007 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_08.XP.out @@ -0,0 +1,165 @@ +<top> + <data> + <contents> + <item> + <name key="key">gum</name> + <count>1412</count> + </item> + <item> + <name key="key">rope</name> + <count>85</count> + </item> + <item> + <name key="key">ladder</name> + <count>0</count> + </item> + <item> + <name key="key">bolt</name> + <count>4123</count> + </item> + <item> + <name key="key">water</name> + <count>17</count> + </item> + </contents> + </data> + <data2> + <contents> + <item> + <name key="key">gum</name> + <count>1412</count> + </item> + <item> + <name key="key">rope</name> + <count>85</count> + </item> + <item> + <name key="key">ladder</name> + <count>0</count> + </item> + <item> + <name key="key">bolt</name> + <count>4123</count> + </item> + <item> + <name key="key">water</name> + <count>17</count> + </item> + </contents> + </data2> + <data3> + <contents> + <item> + <name key="key">gum</name> + <count>1412</count> + </item> + <item> + <name key="key">rope</name> + <count>85</count> + </item> + <item> + <name key="key">ladder</name> + <count>0</count> + </item> + <item> + <name key="key">bolt</name> + <count>4123</count> + </item> + <item> + <name key="key">water</name> + <count>17</count> + <test>one</test> + </item> + </contents> + </data3> + <data4> + <contents> + <item> + <name key="key">gum</name> + <count>1412</count> + <sub> + <name>0</name> + <next>1</next> + </sub> + <sub> + <name>1</name> + <next>2</next> + </sub> + <sub> + <name>2</name> + <next>3</next> + </sub> + <last>3</last> + </item> + <item> + <name key="key">rope</name> + <count>85</count> + <sub> + <name>0</name> + <next>1</next> + </sub> + <sub> + <name>1</name> + <next>2</next> + </sub> + <sub> + <name>2</name> + <next>3</next> + </sub> + <last>3</last> + </item> + <item> + <name key="key">ladder</name> + <count>0</count> + <sub> + <name>0</name> + <next>1</next> + </sub> + <sub> + <name>1</name> + <next>2</next> + </sub> + <sub> + <name>2</name> + <next>3</next> + </sub> + <last>3</last> + </item> + <item> + <name key="key">bolt</name> + <count>4123</count> + <sub> + <name>0</name> + <next>1</next> + </sub> + <sub> + <name>1</name> + <next>2</next> + </sub> + <sub> + <name>2</name> + <next>3</next> + </sub> + <last>3</last> + </item> + <item> + <name key="key">water</name> + <count>17</count> + <sub> + <name>0</name> + <next>1</next> + </sub> + <sub> + <name>1</name> + <next>2</next> + </sub> + <sub> + <name>2</name> + <next>3</next> + </sub> + <last>3</last> + <test>one</test> + </item> + </contents> + </data4> +</top> diff --git a/contrib/libxo/tests/core/saved/test_09.E.err b/contrib/libxo/tests/core/saved/test_09.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.E.err diff --git a/contrib/libxo/tests/core/saved/test_09.E.out b/contrib/libxo/tests/core/saved/test_09.E.out new file mode 100644 index 000000000000..14e6047b4aa0 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.E.out @@ -0,0 +1,40 @@ +op create: [test] [] [0] +op open_container: [top] [] [0x810] +op open_container: [data] [] [0x810] +op open_container: [contents] [] [0x810] +op open_leaf_list: [name] [] [0] +op string: [name] [gum] [0x2000] +op string: [name] [rope] [0x2000] +op string: [name] [ladder] [0x2000] +op string: [name] [bolt] [0x2000] +op string: [name] [water] [0x2000] +op close_leaf_list: [name] [] [0] +op close_container: [contents] [] [0] +op open_container: [contents] [] [0x810] +op open_leaf_list: [item] [] [0] +op string: [item] [gum] [0x2000] +op string: [item] [rope] [0x2000] +op string: [item] [ladder] [0x2000] +op string: [item] [bolt] [0x2000] +op string: [item] [water] [0x2000] +op close_leaf_list: [item] [] [0] +op close_container: [contents] [] [0] +op open_container: [contents] [] [0x810] +op open_list: [item] [] [0] +op string: [item] [gum] [0x2000] +op string: [item] [rope] [0x2000] +op string: [item] [ladder] [0x2000] +op string: [item] [bolt] [0x2000] +op string: [item] [water] [0x2000] +op close_list: [item] [] [0] +op string: [total] [six] [0] +op string: [one] [one] [0] +op open_leaf_list: [two] [] [0] +op string: [two] [two] [0x2000] +op close_leaf_list: [two] [] [0] +op string: [three] [three] [0] +op close_container: [contents] [] [0] +op close_container: [data] [] [0] +op close_container: [top] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_09.H.err b/contrib/libxo/tests/core/saved/test_09.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.H.err diff --git a/contrib/libxo/tests/core/saved/test_09.H.out b/contrib/libxo/tests/core/saved/test_09.H.out new file mode 100644 index 000000000000..899cd2f40458 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.H.out @@ -0,0 +1 @@ +<div class="line"><div class="title">Item </div><div class="title"> Count</div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="name">gum </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="name">rope </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="name">ladder </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="name">bolt </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="name">water </div></div><div class="line"></div><div class="line"></div><div class="line"><div class="title">Item </div><div class="title"> Count</div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">gum </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">rope </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">ladder </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">bolt </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">water </div></div><div class="line"></div><div class="line"></div><div class="line"><div class="title">Test </div><div class="title"> Three</div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">gum </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">rope </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">ladder </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">bolt </div></div><div class="line"><div class="text">Name: </div><div class="data" data-tag="item">water </div></div><div class="line"><div class="label">Total:</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="total">six</div></div><div class="line"><div class="data" data-tag="one">one</div><div class="data" data-tag="two">two</div><div class="data" data-tag="three">three</div></div><div class="line"></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_09.HIPx.err b/contrib/libxo/tests/core/saved/test_09.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_09.HIPx.out b/contrib/libxo/tests/core/saved/test_09.HIPx.out new file mode 100644 index 000000000000..a63f29264df9 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.HIPx.out @@ -0,0 +1,93 @@ +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name" data-xpath="/top/data/contents/name">gum </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name" data-xpath="/top/data/contents/name">rope </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name" data-xpath="/top/data/contents/name">ladder </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name" data-xpath="/top/data/contents/name">bolt </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name" data-xpath="/top/data/contents/name">water </div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">gum </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">rope </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">ladder </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">bolt </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">water </div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Test </div> + <div class="title"> Three</div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">gum </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">rope </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">ladder </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">bolt </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item" data-xpath="/top/data/contents/item">water </div> +</div> +<div class="line"> + <div class="label">Total:</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="total" data-xpath="/top/data/contents/total">six</div> +</div> +<div class="line"> + <div class="data" data-tag="one" data-xpath="/top/data/contents/one">one</div> + <div class="data" data-tag="two" data-xpath="/top/data/contents/two">two</div> + <div class="data" data-tag="three" data-xpath="/top/data/contents/three">three</div> +</div> +<div class="line"> +</div> diff --git a/contrib/libxo/tests/core/saved/test_09.HP.err b/contrib/libxo/tests/core/saved/test_09.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.HP.err diff --git a/contrib/libxo/tests/core/saved/test_09.HP.out b/contrib/libxo/tests/core/saved/test_09.HP.out new file mode 100644 index 000000000000..8a8f700338e6 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.HP.out @@ -0,0 +1,93 @@ +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name">gum </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name">rope </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name">ladder </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name">bolt </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="name">water </div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title"> Count</div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">gum </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">rope </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">ladder </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">bolt </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">water </div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="title">Test </div> + <div class="title"> Three</div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">gum </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">rope </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">ladder </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">bolt </div> +</div> +<div class="line"> + <div class="text">Name: </div> + <div class="data" data-tag="item">water </div> +</div> +<div class="line"> + <div class="label">Total:</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="total">six</div> +</div> +<div class="line"> + <div class="data" data-tag="one">one</div> + <div class="data" data-tag="two">two</div> + <div class="data" data-tag="three">three</div> +</div> +<div class="line"> +</div> diff --git a/contrib/libxo/tests/core/saved/test_09.J.err b/contrib/libxo/tests/core/saved/test_09.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.J.err diff --git a/contrib/libxo/tests/core/saved/test_09.J.out b/contrib/libxo/tests/core/saved/test_09.J.out new file mode 100644 index 000000000000..acd572638049 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.J.out @@ -0,0 +1 @@ +{"top": {"data": {"contents": {"name": ["gum","rope","ladder","bolt","water"]}, "contents": {"item": ["gum","rope","ladder","bolt","water"]}, "contents": {"item": ["gum","rope","ladder","bolt","water"],"total":"six","one":"one", "two": ["two"],"three":"three"}}}} diff --git a/contrib/libxo/tests/core/saved/test_09.JP.err b/contrib/libxo/tests/core/saved/test_09.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.JP.err diff --git a/contrib/libxo/tests/core/saved/test_09.JP.out b/contrib/libxo/tests/core/saved/test_09.JP.out new file mode 100644 index 000000000000..48e20c146673 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.JP.out @@ -0,0 +1,39 @@ +{ + "top": { + "data": { + "contents": { + "name": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "contents": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "contents": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ], + "total": "six", + "one": "one", + "two": [ + "two" + ], + "three": "three" + } + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_09.JPu.err b/contrib/libxo/tests/core/saved/test_09.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_09.JPu.out b/contrib/libxo/tests/core/saved/test_09.JPu.out new file mode 100644 index 000000000000..48e20c146673 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.JPu.out @@ -0,0 +1,39 @@ +{ + "top": { + "data": { + "contents": { + "name": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "contents": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "contents": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ], + "total": "six", + "one": "one", + "two": [ + "two" + ], + "three": "three" + } + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_09.T.err b/contrib/libxo/tests/core/saved/test_09.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.T.err diff --git a/contrib/libxo/tests/core/saved/test_09.T.out b/contrib/libxo/tests/core/saved/test_09.T.out new file mode 100644 index 000000000000..5bb163ed8668 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.T.out @@ -0,0 +1,25 @@ +Item Count +Name: gum +Name: rope +Name: ladder +Name: bolt +Name: water + + +Item Count +Name: gum +Name: rope +Name: ladder +Name: bolt +Name: water + + +Test Three +Name: gum +Name: rope +Name: ladder +Name: bolt +Name: water +Total:: six +onetwothree + diff --git a/contrib/libxo/tests/core/saved/test_09.X.err b/contrib/libxo/tests/core/saved/test_09.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.X.err diff --git a/contrib/libxo/tests/core/saved/test_09.X.out b/contrib/libxo/tests/core/saved/test_09.X.out new file mode 100644 index 000000000000..21ce1ce6956d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.X.out @@ -0,0 +1 @@ +<top><data><contents><name>gum</name><name>rope</name><name>ladder</name><name>bolt</name><name>water</name></contents><contents><item>gum</item><item>rope</item><item>ladder</item><item>bolt</item><item>water</item></contents><contents><item>gum</item><item>rope</item><item>ladder</item><item>bolt</item><item>water</item><total>six</total><one>one</one><two>two</two><three>three</three></contents></data></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_09.XP.err b/contrib/libxo/tests/core/saved/test_09.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.XP.err diff --git a/contrib/libxo/tests/core/saved/test_09.XP.out b/contrib/libxo/tests/core/saved/test_09.XP.out new file mode 100644 index 000000000000..9476126e372c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_09.XP.out @@ -0,0 +1,29 @@ +<top> + <data> + <contents> + <name>gum</name> + <name>rope</name> + <name>ladder</name> + <name>bolt</name> + <name>water</name> + </contents> + <contents> + <item>gum</item> + <item>rope</item> + <item>ladder</item> + <item>bolt</item> + <item>water</item> + </contents> + <contents> + <item>gum</item> + <item>rope</item> + <item>ladder</item> + <item>bolt</item> + <item>water</item> + <total>six</total> + <one>one</one> + <two>two</two> + <three>three</three> + </contents> + </data> +</top> diff --git a/contrib/libxo/tests/core/saved/test_10.E.err b/contrib/libxo/tests/core/saved/test_10.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.E.err diff --git a/contrib/libxo/tests/core/saved/test_10.E.out b/contrib/libxo/tests/core/saved/test_10.E.out new file mode 100644 index 000000000000..d869a7c4f0a2 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.E.out @@ -0,0 +1,126 @@ +op create: [test] [] [0] +op version: [] [3.1.4] [0] +op open_container: [top] [] [0x4000810] +op attr: [test] [value] [0] +op open_container: [data] [] [0x4000810] +op open_list: [item] [] [0] +op attr: [test2] [value2] [0] +op close_list: [item] [] [0] +op string: [data] [bold] [0] +op string: [data] [bold-ul] [0] +op string: [data] [triple] [0] +op string: [data] [inv-ul] [0] +op string: [data] [underline] [0] +op string: [data] [plain] [0] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op attr: [test3] [value3] [0] +op string: [sku] [GRO-000-415] [0x98] +op string: [name] [gum] [0x80] +op content: [sold] [1412] [0x20] +op content: [in-stock] [54] [0] +op content: [on-order] [10] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-212] [0x98] +op string: [name] [rope] [0x80] +op content: [sold] [85] [0x20] +op content: [in-stock] [4] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-517] [0x98] +op string: [name] [ladder] [0x80] +op content: [sold] [0] [0x20] +op content: [in-stock] [2] [0] +op content: [on-order] [1] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op attr: [test3] [value3] [0] +op string: [sku] [HRD-000-632] [0x98] +op string: [name] [bolt] [0x80] +op content: [sold] [4123] [0x20] +op content: [in-stock] [144] [0] +op content: [on-order] [42] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op attr: [test3] [value3] [0] +op string: [sku] [GRO-000-2331] [0x98] +op string: [name] [water] [0x80] +op content: [sold] [17] [0x20] +op content: [in-stock] [14] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data] [] [0] +op open_container: [data] [] [0x4000810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op string: [sku] [GRO-000-415] [0x98] +op string: [name] [gum] [0x80] +op content: [sold] [1412.0] [0x20] +op content: [in-stock] [54] [0] +op content: [on-order] [10] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op string: [sku] [HRD-000-212] [0x98] +op string: [name] [rope] [0x80] +op content: [sold] [85.0] [0x20] +op content: [in-stock] [4] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op string: [sku] [HRD-000-517] [0x98] +op string: [name] [ladder] [0x80] +op content: [sold] [0] [0x20] +op content: [in-stock] [2] [0] +op content: [on-order] [1] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op string: [sku] [HRD-000-632] [0x98] +op string: [name] [bolt] [0x80] +op content: [sold] [4123.0] [0x20] +op content: [in-stock] [144] [0] +op content: [on-order] [42] [0] +op close_instance: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op string: [sku] [GRO-000-2331] [0x98] +op string: [name] [water] [0x80] +op content: [sold] [17.0] [0x20] +op content: [in-stock] [14] [0] +op content: [on-order] [2] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data] [] [0] +op open_container: [data] [] [0x4000810] +op open_list: [item] [] [0] +op open_instance: [item] [] [0x4000810] +op string: [sku] [GRO-000-533] [0x98] +op string: [name] [fish] [0x80] +op content: [sold] [1321.0] [0x20] +op content: [in-stock] [45] [0] +op content: [on-order] [1] [0] +op close_instance: [item] [] [0] +op close_list: [item] [] [0] +op close_container: [data] [] [0] +op open_container: [data] [] [0x4000810] +op open_list: [item] [] [0] +op attr: [test4] [value4] [0] +op string: [item] [gum] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [rope] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [ladder] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [bolt] [0x2000] +op attr: [test4] [value4] [0] +op string: [item] [water] [0x2000] +op close_list: [item] [] [0] +op close_container: [data] [] [0] +op content: [cost] [425] [0] +op content: [cost] [455] [0] +op close_container: [top] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_10.H.err b/contrib/libxo/tests/core/saved/test_10.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.H.err diff --git a/contrib/libxo/tests/core/saved/test_10.H.out b/contrib/libxo/tests/core/saved/test_10.H.out new file mode 100644 index 000000000000..d4ec07da82e6 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.H.out @@ -0,0 +1 @@ +<div class="line"><div class="title color-fg-blue">blue</div><div class="title color-fg-green color-bg-blue">green</div><div class="title color-fg-red color-bg-green">red</div><div class="title color-fg-yellow color-bg-red">yellow</div><div class="title color-bg-yellow">default</div></div><div class="line"><div class="data effect-bold" data-tag="data">bold</div><div class="text effect-bold"> </div><div class="data effect-bold effect-underline" data-tag="data">bold-ul</div><div class="text effect-bold effect-underline"> </div><div class="data effect-bold effect-underline effect-inverse color-fg-inverse color-bg-inverse" data-tag="data">triple</div><div class="text effect-bold effect-underline effect-inverse color-fg-inverse color-bg-inverse"> </div><div class="data effect-underline effect-inverse color-fg-inverse color-bg-inverse" data-tag="data">inv-ul</div><div class="text effect-underline effect-inverse color-fg-inverse color-bg-inverse"> </div><div class="data effect-underline" data-tag="data">underline</div><div class="text effect-underline"> </div><div class="data" data-tag="data">plain</div></div><div class="line"><div class="title">Item </div><div class="title effect-bold effect-underline"> Total Sold</div><div class="title effect-underline"> In Stock</div><div class="title effect-underline effect-inverse color-fg-inverse color-bg-inverse"> On Order</div><div class="title"> SKU</div></div><div class="line"><div class="data" data-tag="name" data-key="key">gum </div><div class="data" data-tag="sold"> 1412</div><div class="data" data-tag="in-stock"> 54</div><div class="data color-fg-yellow" data-tag="on-order"> 10</div><div class="data" data-tag="sku" data-key="key"> GRO-000-415</div></div><div class="line"><div class="data" data-tag="name" data-key="key">rope </div><div class="data" data-tag="sold"> 85</div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock"> 4</div><div class="data" data-tag="on-order"> 2</div><div class="data" data-tag="sku" data-key="key"> HRD-000-212</div></div><div class="line"><div class="data" data-tag="name" data-key="key">ladder </div><div class="data" data-tag="sold"> 0</div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock"> 2</div><div class="data" data-tag="on-order"> 1</div><div class="data" data-tag="sku" data-key="key"> HRD-000-517</div></div><div class="line"><div class="data" data-tag="name" data-key="key">bolt </div><div class="data" data-tag="sold"> 4123</div><div class="data" data-tag="in-stock"> 144</div><div class="data color-fg-yellow" data-tag="on-order"> 42</div><div class="data" data-tag="sku" data-key="key"> HRD-000-632</div></div><div class="line"><div class="data" data-tag="name" data-key="key">water </div><div class="data" data-tag="sold"> 17</div><div class="data" data-tag="in-stock"> 14</div><div class="data" data-tag="on-order"> 2</div><div class="data" data-tag="sku" data-key="key"> GRO-000-2331</div></div><div class="line"></div><div class="line"></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">gum</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">1412.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">54</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">10</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">GRO-000-415</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">rope</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">85.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">4</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">2</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">HRD-000-212</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">ladder</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">2</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">1</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">HRD-000-517</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">bolt</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">4123.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">144</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">42</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">HRD-000-632</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">water</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label">Total sold</div><div class="text">: </div><div class="data" data-tag="sold">17.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">14</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">2</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">GRO-000-2331</div></div><div class="line"><div class="label">Item</div><div class="text"> '</div><div class="data" data-tag="name" data-key="key">fish</div><div class="text">':</div></div><div class="line"><div class="padding"> </div><div class="label effect-bold color-fg-white color-bg-blue">Total sold</div><div class="text effect-bold color-fg-white color-bg-blue">: </div><div class="data effect-bold color-fg-white color-bg-blue" data-tag="sold">1321.0</div></div><div class="line"><div class="padding"> </div><div class="label">In stock</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="in-stock">45</div></div><div class="line"><div class="padding"> </div><div class="label">On order</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="on-order">1</div></div><div class="line"><div class="padding"> </div><div class="label">SKU</div><div class="text">: </div><div class="data" data-tag="sku" data-key="key">GRO-000-533</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">gum</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">rope</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">ladder</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">bolt</div></div><div class="line"><div class="label">Item</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="item">water</div></div><div class="line"><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div><div class="text">X</div></div><div class="line"><div class="text">X</div><div class="padding"> </div><div class="text">X</div><div class="label">Cost</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="cost">425</div></div><div class="line"><div class="text">X</div><div class="padding"> </div><div class="text">X</div><div class="label">Cost</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="cost">455</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_10.HIPx.err b/contrib/libxo/tests/core/saved/test_10.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_10.HIPx.out b/contrib/libxo/tests/core/saved/test_10.HIPx.out new file mode 100644 index 000000000000..ef64173f54a5 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.HIPx.out @@ -0,0 +1,316 @@ +<div class="line"> + <div class="title color-fg-blue">blue</div> + <div class="title color-fg-green color-bg-blue">green</div> + <div class="title color-fg-red color-bg-green">red</div> + <div class="title color-fg-yellow color-bg-red">yellow</div> + <div class="title color-bg-yellow">default</div> +</div> +<div class="line"> + <div class="data effect-bold" data-tag="data" data-xpath="/top/data/data">bold</div> + <div class="text effect-bold"> </div> + <div class="data effect-bold effect-underline" data-tag="data" data-xpath="/top/data/data">bold-ul</div> + <div class="text effect-bold effect-underline"> </div> + <div class="data effect-bold effect-underline effect-inverse color-fg-inverse color-bg-inverse" data-tag="data" data-xpath="/top/data/data">triple</div> + <div class="text effect-bold effect-underline effect-inverse color-fg-inverse color-bg-inverse"> </div> + <div class="data effect-underline effect-inverse color-fg-inverse color-bg-inverse" data-tag="data" data-xpath="/top/data/data">inv-ul</div> + <div class="text effect-underline effect-inverse color-fg-inverse color-bg-inverse"> </div> + <div class="data effect-underline" data-tag="data" data-xpath="/top/data/data">underline</div> + <div class="text effect-underline"> </div> + <div class="data" data-tag="data" data-xpath="/top/data/data">plain</div> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title effect-bold effect-underline"> Total Sold</div> + <div class="title effect-underline"> In Stock</div> + <div class="title effect-underline effect-inverse color-fg-inverse color-bg-inverse"> On Order</div> + <div class="title"> SKU</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">gum </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'GRO-000-415'][name = 'gum']/sold" data-type="number" data-help="Number of items sold"> 1412</div> + <div class="data" data-tag="in-stock" data-xpath="/top/data/item[sku = 'GRO-000-415'][name = 'gum']/in-stock" data-type="number" data-help="Number of items in stock"> 54</div> + <div class="data color-fg-yellow" data-tag="on-order" data-xpath="/top/data/item[sku = 'GRO-000-415'][name = 'gum']/on-order" data-type="number" data-help="Number of items on order"> 10</div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> GRO-000-415</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">rope </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'HRD-000-212'][name = 'rope']/sold" data-type="number" data-help="Number of items sold"> 85</div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'HRD-000-212'][name = 'rope']/in-stock" data-type="number" data-help="Number of items in stock"> 4</div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'HRD-000-212'][name = 'rope']/on-order" data-type="number" data-help="Number of items on order"> 2</div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-212</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">ladder </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'HRD-000-517'][name = 'ladder']/sold" data-type="number" data-help="Number of items sold"> 0</div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'HRD-000-517'][name = 'ladder']/in-stock" data-type="number" data-help="Number of items in stock"> 2</div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'HRD-000-517'][name = 'ladder']/on-order" data-type="number" data-help="Number of items on order"> 1</div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-517</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">bolt </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'HRD-000-632'][name = 'bolt']/sold" data-type="number" data-help="Number of items sold"> 4123</div> + <div class="data" data-tag="in-stock" data-xpath="/top/data/item[sku = 'HRD-000-632'][name = 'bolt']/in-stock" data-type="number" data-help="Number of items in stock"> 144</div> + <div class="data color-fg-yellow" data-tag="on-order" data-xpath="/top/data/item[sku = 'HRD-000-632'][name = 'bolt']/on-order" data-type="number" data-help="Number of items on order"> 42</div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> HRD-000-632</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">water </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'GRO-000-2331'][name = 'water']/sold" data-type="number" data-help="Number of items sold"> 17</div> + <div class="data" data-tag="in-stock" data-xpath="/top/data/item[sku = 'GRO-000-2331'][name = 'water']/in-stock" data-type="number" data-help="Number of items in stock"> 14</div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'GRO-000-2331'][name = 'water']/on-order" data-type="number" data-help="Number of items on order"> 2</div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key"> GRO-000-2331</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">gum</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'GRO-000-415'][name = 'gum']/sold" data-type="number" data-help="Number of items sold">1412.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'GRO-000-415'][name = 'gum']/in-stock" data-type="number" data-help="Number of items in stock">54</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'GRO-000-415'][name = 'gum']/on-order" data-type="number" data-help="Number of items on order">10</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">GRO-000-415</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">rope</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'HRD-000-212'][name = 'rope']/sold" data-type="number" data-help="Number of items sold">85.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'HRD-000-212'][name = 'rope']/in-stock" data-type="number" data-help="Number of items in stock">4</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'HRD-000-212'][name = 'rope']/on-order" data-type="number" data-help="Number of items on order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">HRD-000-212</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">ladder</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'HRD-000-517'][name = 'ladder']/sold" data-type="number" data-help="Number of items sold">0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'HRD-000-517'][name = 'ladder']/in-stock" data-type="number" data-help="Number of items in stock">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'HRD-000-517'][name = 'ladder']/on-order" data-type="number" data-help="Number of items on order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">HRD-000-517</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">bolt</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'HRD-000-632'][name = 'bolt']/sold" data-type="number" data-help="Number of items sold">4123.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'HRD-000-632'][name = 'bolt']/in-stock" data-type="number" data-help="Number of items in stock">144</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'HRD-000-632'][name = 'bolt']/on-order" data-type="number" data-help="Number of items on order">42</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">HRD-000-632</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">water</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold" data-xpath="/top/data/item[sku = 'GRO-000-2331'][name = 'water']/sold" data-type="number" data-help="Number of items sold">17.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock" data-xpath="/top/data/item[sku = 'GRO-000-2331'][name = 'water']/in-stock" data-type="number" data-help="Number of items in stock">14</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'GRO-000-2331'][name = 'water']/on-order" data-type="number" data-help="Number of items on order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">GRO-000-2331</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-xpath="/top/data/item/name" data-type="string" data-help="Name of the item" data-key="key">fish</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label effect-bold color-fg-white color-bg-blue">Total sold</div> + <div class="text effect-bold color-fg-white color-bg-blue">: </div> + <div class="data effect-bold color-fg-white color-bg-blue" data-tag="sold" data-xpath="/top/data/item[sku = 'GRO-000-533'][name = 'fish']/sold" data-type="number" data-help="Number of items sold">1321.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock" data-xpath="/top/data/item[sku = 'GRO-000-533'][name = 'fish']/in-stock" data-type="number" data-help="Number of items in stock">45</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order" data-xpath="/top/data/item[sku = 'GRO-000-533'][name = 'fish']/on-order" data-type="number" data-help="Number of items on order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-xpath="/top/data/item/sku" data-type="string" data-help="Stock Keeping Unit" data-key="key">GRO-000-533</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top/data/item">gum</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top/data/item">rope</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top/data/item">ladder</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top/data/item">bolt</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item" data-xpath="/top/data/item">water</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost" data-xpath="/top/cost">425</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost" data-xpath="/top/cost">455</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_10.HP.err b/contrib/libxo/tests/core/saved/test_10.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.HP.err diff --git a/contrib/libxo/tests/core/saved/test_10.HP.out b/contrib/libxo/tests/core/saved/test_10.HP.out new file mode 100644 index 000000000000..abb1b0183656 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.HP.out @@ -0,0 +1,316 @@ +<div class="line"> + <div class="title color-fg-blue">blue</div> + <div class="title color-fg-green color-bg-blue">green</div> + <div class="title color-fg-red color-bg-green">red</div> + <div class="title color-fg-yellow color-bg-red">yellow</div> + <div class="title color-bg-yellow">default</div> +</div> +<div class="line"> + <div class="data effect-bold" data-tag="data">bold</div> + <div class="text effect-bold"> </div> + <div class="data effect-bold effect-underline" data-tag="data">bold-ul</div> + <div class="text effect-bold effect-underline"> </div> + <div class="data effect-bold effect-underline effect-inverse color-fg-inverse color-bg-inverse" data-tag="data">triple</div> + <div class="text effect-bold effect-underline effect-inverse color-fg-inverse color-bg-inverse"> </div> + <div class="data effect-underline effect-inverse color-fg-inverse color-bg-inverse" data-tag="data">inv-ul</div> + <div class="text effect-underline effect-inverse color-fg-inverse color-bg-inverse"> </div> + <div class="data effect-underline" data-tag="data">underline</div> + <div class="text effect-underline"> </div> + <div class="data" data-tag="data">plain</div> +</div> +<div class="line"> + <div class="title">Item </div> + <div class="title effect-bold effect-underline"> Total Sold</div> + <div class="title effect-underline"> In Stock</div> + <div class="title effect-underline effect-inverse color-fg-inverse color-bg-inverse"> On Order</div> + <div class="title"> SKU</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">gum </div> + <div class="data" data-tag="sold"> 1412</div> + <div class="data" data-tag="in-stock"> 54</div> + <div class="data color-fg-yellow" data-tag="on-order"> 10</div> + <div class="data" data-tag="sku" data-key="key"> GRO-000-415</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">rope </div> + <div class="data" data-tag="sold"> 85</div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock"> 4</div> + <div class="data" data-tag="on-order"> 2</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-212</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">ladder </div> + <div class="data" data-tag="sold"> 0</div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock"> 2</div> + <div class="data" data-tag="on-order"> 1</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-517</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">bolt </div> + <div class="data" data-tag="sold"> 4123</div> + <div class="data" data-tag="in-stock"> 144</div> + <div class="data color-fg-yellow" data-tag="on-order"> 42</div> + <div class="data" data-tag="sku" data-key="key"> HRD-000-632</div> +</div> +<div class="line"> + <div class="data" data-tag="name" data-key="key">water </div> + <div class="data" data-tag="sold"> 17</div> + <div class="data" data-tag="in-stock"> 14</div> + <div class="data" data-tag="on-order"> 2</div> + <div class="data" data-tag="sku" data-key="key"> GRO-000-2331</div> +</div> +<div class="line"> +</div> +<div class="line"> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">gum</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">1412.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">54</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">10</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">GRO-000-415</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">rope</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">85.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">4</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">HRD-000-212</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">ladder</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">HRD-000-517</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">bolt</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">4123.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">144</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">42</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">HRD-000-632</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">water</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">Total sold</div> + <div class="text">: </div> + <div class="data" data-tag="sold">17.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data effect-inverse color-fg-inverse color-bg-inverse" data-tag="in-stock">14</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">2</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">GRO-000-2331</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="text"> '</div> + <div class="data" data-tag="name" data-key="key">fish</div> + <div class="text">':</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label effect-bold color-fg-white color-bg-blue">Total sold</div> + <div class="text effect-bold color-fg-white color-bg-blue">: </div> + <div class="data effect-bold color-fg-white color-bg-blue" data-tag="sold">1321.0</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">In stock</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="in-stock">45</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">On order</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="on-order">1</div> +</div> +<div class="line"> + <div class="padding"> </div> + <div class="label">SKU</div> + <div class="text">: </div> + <div class="data" data-tag="sku" data-key="key">GRO-000-533</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">gum</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">rope</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">ladder</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">bolt</div> +</div> +<div class="line"> + <div class="label">Item</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="item">water</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> + <div class="text">X</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost">425</div> +</div> +<div class="line"> + <div class="text">X</div> + <div class="padding"> </div> + <div class="text">X</div> + <div class="label">Cost</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="cost">455</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_10.J.err b/contrib/libxo/tests/core/saved/test_10.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.J.err diff --git a/contrib/libxo/tests/core/saved/test_10.J.out b/contrib/libxo/tests/core/saved/test_10.J.out new file mode 100644 index 000000000000..9d9d729fff2d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.J.out @@ -0,0 +1 @@ +{"__version": "3.1.4", "top": {"data": {"item": [],"data":"bold","data":"bold-ul","data":"triple","data":"inv-ul","data":"underline","data":"plain", "item": [{"sku":"GRO-000-415","name":"gum","sold":1412,"in-stock":54,"on-order":10}, {"sku":"HRD-000-212","name":"rope","sold":85,"in-stock":4,"on-order":2}, {"sku":"HRD-000-517","name":"ladder","sold":0,"in-stock":2,"on-order":1}, {"sku":"HRD-000-632","name":"bolt","sold":4123,"in-stock":144,"on-order":42}, {"sku":"GRO-000-2331","name":"water","sold":17,"in-stock":14,"on-order":2}]}, "data": {"item": [{"sku":"GRO-000-415","name":"gum","sold":1412.0,"in-stock":54,"on-order":10}, {"sku":"HRD-000-212","name":"rope","sold":85.0,"in-stock":4,"on-order":2}, {"sku":"HRD-000-517","name":"ladder","sold":0,"in-stock":2,"on-order":1}, {"sku":"HRD-000-632","name":"bolt","sold":4123.0,"in-stock":144,"on-order":42}, {"sku":"GRO-000-2331","name":"water","sold":17.0,"in-stock":14,"on-order":2}]}, "data": {"item": [{"sku":"GRO-000-533","name":"fish","sold":1321.0,"in-stock":45,"on-order":1}]}, "data": {"item": ["gum","rope","ladder","bolt","water"]},"cost":425,"cost":455}} diff --git a/contrib/libxo/tests/core/saved/test_10.JP.err b/contrib/libxo/tests/core/saved/test_10.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.JP.err diff --git a/contrib/libxo/tests/core/saved/test_10.JP.out b/contrib/libxo/tests/core/saved/test_10.JP.out new file mode 100644 index 000000000000..0ca326995a7b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.JP.out @@ -0,0 +1,113 @@ +{ + "__version": "3.1.4", + "top": { + "data": { + "item": [ + ], + "data": "bold", + "data": "bold-ul", + "data": "triple", + "data": "inv-ul", + "data": "underline", + "data": "plain", + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412, + "in-stock": 54, + "on-order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85, + "in-stock": 4, + "on-order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in-stock": 2, + "on-order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123, + "in-stock": 144, + "on-order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17, + "in-stock": 14, + "on-order": 2 + } + ] + }, + "data": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412.0, + "in-stock": 54, + "on-order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85.0, + "in-stock": 4, + "on-order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in-stock": 2, + "on-order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123.0, + "in-stock": 144, + "on-order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17.0, + "in-stock": 14, + "on-order": 2 + } + ] + }, + "data": { + "item": [ + { + "sku": "GRO-000-533", + "name": "fish", + "sold": 1321.0, + "in-stock": 45, + "on-order": 1 + } + ] + }, + "data": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "cost": 425, + "cost": 455 + } +} diff --git a/contrib/libxo/tests/core/saved/test_10.JPu.err b/contrib/libxo/tests/core/saved/test_10.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_10.JPu.out b/contrib/libxo/tests/core/saved/test_10.JPu.out new file mode 100644 index 000000000000..2dd55419304a --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.JPu.out @@ -0,0 +1,113 @@ +{ + "__version": "3.1.4", + "top": { + "data": { + "item": [ + ], + "data": "bold", + "data": "bold-ul", + "data": "triple", + "data": "inv-ul", + "data": "underline", + "data": "plain", + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412, + "in_stock": 54, + "on_order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85, + "in_stock": 4, + "on_order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in_stock": 2, + "on_order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123, + "in_stock": 144, + "on_order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17, + "in_stock": 14, + "on_order": 2 + } + ] + }, + "data": { + "item": [ + { + "sku": "GRO-000-415", + "name": "gum", + "sold": 1412.0, + "in_stock": 54, + "on_order": 10 + }, + { + "sku": "HRD-000-212", + "name": "rope", + "sold": 85.0, + "in_stock": 4, + "on_order": 2 + }, + { + "sku": "HRD-000-517", + "name": "ladder", + "sold": 0, + "in_stock": 2, + "on_order": 1 + }, + { + "sku": "HRD-000-632", + "name": "bolt", + "sold": 4123.0, + "in_stock": 144, + "on_order": 42 + }, + { + "sku": "GRO-000-2331", + "name": "water", + "sold": 17.0, + "in_stock": 14, + "on_order": 2 + } + ] + }, + "data": { + "item": [ + { + "sku": "GRO-000-533", + "name": "fish", + "sold": 1321.0, + "in_stock": 45, + "on_order": 1 + } + ] + }, + "data": { + "item": [ + "gum", + "rope", + "ladder", + "bolt", + "water" + ] + }, + "cost": 425, + "cost": 455 + } +} diff --git a/contrib/libxo/tests/core/saved/test_10.T.err b/contrib/libxo/tests/core/saved/test_10.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.T.err diff --git a/contrib/libxo/tests/core/saved/test_10.T.out b/contrib/libxo/tests/core/saved/test_10.T.out new file mode 100644 index 000000000000..21fa81bc9aae --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.T.out @@ -0,0 +1,48 @@ +[34mblue[44m[32mgreen[42m[31mred[41m[33myellow[43m[39mdefault[0m +[1mbold [4mbold-ul [7mtriple [0;4;7minv-ul [0;4munderline [0mplain +Item [1;4m Total Sold[0;4m In Stock[7m On Order[0m SKU +gum 1412 54[33m 10[39m GRO-000-415 +rope 85[7m 4[0m 2 HRD-000-212 +ladder 0[7m 2[0m 1 HRD-000-517 +bolt 4123 144[33m 42[39m HRD-000-632 +water 17 14 2 GRO-000-2331 + + +Item 'gum': + Total sold: 1412.0 + In stock: [7m54[0m + On order: 10 + SKU: GRO-000-415 +Item 'rope': + Total sold: 85.0 + In stock: [7m4[0m + On order: 2 + SKU: HRD-000-212 +Item 'ladder': + Total sold: 0 + In stock: [7m2[0m + On order: 1 + SKU: HRD-000-517 +Item 'bolt': + Total sold: 4123.0 + In stock: [7m144[0m + On order: 42 + SKU: HRD-000-632 +Item 'water': + Total sold: 17.0 + In stock: [7m14[0m + On order: 2 + SKU: GRO-000-2331 +Item 'fish': + [1;37;44mTotal sold: 1321.0[0m + In stock: 45 + On order: 1 + SKU: GRO-000-533 +Item: gum +Item: rope +Item: ladder +Item: bolt +Item: water +XXXXXXXX +X XCost: 425 +X XCost: 455 diff --git a/contrib/libxo/tests/core/saved/test_10.X.err b/contrib/libxo/tests/core/saved/test_10.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.X.err diff --git a/contrib/libxo/tests/core/saved/test_10.X.out b/contrib/libxo/tests/core/saved/test_10.X.out new file mode 100644 index 000000000000..c9321566d907 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.X.out @@ -0,0 +1 @@ +<top version="3.1.4"><data test="value"><data test2="value2">bold</data><data>bold-ul</data><data>triple</data><data>inv-ul</data><data>underline</data><data>plain</data><item><sku test3="value3" key="key">GRO-000-415</sku><name key="key">gum</name><sold>1412</sold><in-stock>54</in-stock><on-order>10</on-order></item><item><sku test3="value3" key="key">HRD-000-212</sku><name key="key">rope</name><sold>85</sold><in-stock>4</in-stock><on-order>2</on-order></item><item><sku test3="value3" key="key">HRD-000-517</sku><name key="key">ladder</name><sold>0</sold><in-stock>2</in-stock><on-order>1</on-order></item><item><sku test3="value3" key="key">HRD-000-632</sku><name key="key">bolt</name><sold>4123</sold><in-stock>144</in-stock><on-order>42</on-order></item><item><sku test3="value3" key="key">GRO-000-2331</sku><name key="key">water</name><sold>17</sold><in-stock>14</in-stock><on-order>2</on-order></item></data><data><item><sku key="key">GRO-000-415</sku><name key="key">gum</name><sold>1412.0</sold><in-stock>54</in-stock><on-order>10</on-order></item><item><sku key="key">HRD-000-212</sku><name key="key">rope</name><sold>85.0</sold><in-stock>4</in-stock><on-order>2</on-order></item><item><sku key="key">HRD-000-517</sku><name key="key">ladder</name><sold>0</sold><in-stock>2</in-stock><on-order>1</on-order></item><item><sku key="key">HRD-000-632</sku><name key="key">bolt</name><sold>4123.0</sold><in-stock>144</in-stock><on-order>42</on-order></item><item><sku key="key">GRO-000-2331</sku><name key="key">water</name><sold>17.0</sold><in-stock>14</in-stock><on-order>2</on-order></item></data><data><item><sku key="key">GRO-000-533</sku><name key="key">fish</name><sold>1321.0</sold><in-stock>45</in-stock><on-order>1</on-order></item></data><data><item test4="value4">gum</item><item test4="value4">rope</item><item test4="value4">ladder</item><item test4="value4">bolt</item><item test4="value4">water</item></data><cost>425</cost><cost>455</cost></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_10.XP.err b/contrib/libxo/tests/core/saved/test_10.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.XP.err diff --git a/contrib/libxo/tests/core/saved/test_10.XP.out b/contrib/libxo/tests/core/saved/test_10.XP.out new file mode 100644 index 000000000000..ec1aa93c7512 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.XP.out @@ -0,0 +1,100 @@ +<top version="3.1.4"> + <data test="value"> + <data test2="value2">bold</data> + <data>bold-ul</data> + <data>triple</data> + <data>inv-ul</data> + <data>underline</data> + <data>plain</data> + <item> + <sku test3="value3" key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + </item> + <item> + <sku test3="value3" key="key">HRD-000-632</sku> + <name key="key">bolt</name> + <sold>4123</sold> + <in-stock>144</in-stock> + <on-order>42</on-order> + </item> + <item> + <sku test3="value3" key="key">GRO-000-2331</sku> + <name key="key">water</name> + <sold>17</sold> + <in-stock>14</in-stock> + <on-order>2</on-order> + </item> + </data> + <data> + <item> + <sku key="key">GRO-000-415</sku> + <name key="key">gum</name> + <sold>1412.0</sold> + <in-stock>54</in-stock> + <on-order>10</on-order> + </item> + <item> + <sku key="key">HRD-000-212</sku> + <name key="key">rope</name> + <sold>85.0</sold> + <in-stock>4</in-stock> + <on-order>2</on-order> + </item> + <item> + <sku key="key">HRD-000-517</sku> + <name key="key">ladder</name> + <sold>0</sold> + <in-stock>2</in-stock> + <on-order>1</on-order> + </item> + <item> + <sku key="key">HRD-000-632</sku> + <name key="key">bolt</name> + <sold>4123.0</sold> + <in-stock>144</in-stock> + <on-order>42</on-order> + </item> + <item> + <sku key="key">GRO-000-2331</sku> + <name key="key">water</name> + <sold>17.0</sold> + <in-stock>14</in-stock> + <on-order>2</on-order> + </item> + </data> + <data> + <item> + <sku key="key">GRO-000-533</sku> + <name key="key">fish</name> + <sold>1321.0</sold> + <in-stock>45</in-stock> + <on-order>1</on-order> + </item> + </data> + <data> + <item test4="value4">gum</item> + <item test4="value4">rope</item> + <item test4="value4">ladder</item> + <item test4="value4">bolt</item> + <item test4="value4">water</item> + </data> + <cost>425</cost> + <cost>455</cost> +</top> diff --git a/contrib/libxo/tests/core/saved/test_10.err b/contrib/libxo/tests/core/saved/test_10.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.err diff --git a/contrib/libxo/tests/core/saved/test_10.out b/contrib/libxo/tests/core/saved/test_10.out new file mode 100644 index 000000000000..c2ad7a005274 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_10.out @@ -0,0 +1,38 @@ +Item Total Sold In Stock On Order SKU +gum 1412 54 10 GRO-000-415 +rope 85 4 2 HRD-000-212 +ladder 0 2 1 HRD-000-517 +bolt 4123 144 42 HRD-000-632 +water 17 14 2 GRO-000-2331 + + +Item 'gum': + Total sold: 1412.0 + In stock: 54 + On order: 10 + SKU: GRO-000-415 +Item 'rope': + Total sold: 85.0 + In stock: 4 + On order: 2 + SKU: HRD-000-212 +Item 'ladder': + Total sold: 0 + In stock: 2 + On order: 1 + SKU: HRD-000-517 +Item 'bolt': + Total sold: 4123.0 + In stock: 144 + On order: 42 + SKU: HRD-000-632 +Item 'water': + Total sold: 17.0 + In stock: 14 + On order: 2 + SKU: GRO-000-2331 +Item 'fish': + Total sold: 1321.0 + In stock: 45 + On order: 1 + SKU: GRO-000-533 diff --git a/contrib/libxo/tests/core/saved/test_11.E.err b/contrib/libxo/tests/core/saved/test_11.E.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.E.err diff --git a/contrib/libxo/tests/core/saved/test_11.E.out b/contrib/libxo/tests/core/saved/test_11.E.out new file mode 100644 index 000000000000..6535180b02b6 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.E.out @@ -0,0 +1,22 @@ +op create: [test] [] [0] +op version: [] [3.1.4] [0] +op open_container: [top] [] [0x10] +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + +op close_container: [top] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_11.H.err b/contrib/libxo/tests/core/saved/test_11.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.H.err diff --git a/contrib/libxo/tests/core/saved/test_11.H.out b/contrib/libxo/tests/core/saved/test_11.H.out new file mode 100644 index 000000000000..0786c345654d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.H.out @@ -0,0 +1,16 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + diff --git a/contrib/libxo/tests/core/saved/test_11.HIPx.err b/contrib/libxo/tests/core/saved/test_11.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.HIPx.err diff --git a/contrib/libxo/tests/core/saved/test_11.HIPx.out b/contrib/libxo/tests/core/saved/test_11.HIPx.out new file mode 100644 index 000000000000..0786c345654d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.HIPx.out @@ -0,0 +1,16 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + diff --git a/contrib/libxo/tests/core/saved/test_11.HP.err b/contrib/libxo/tests/core/saved/test_11.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.HP.err diff --git a/contrib/libxo/tests/core/saved/test_11.HP.out b/contrib/libxo/tests/core/saved/test_11.HP.out new file mode 100644 index 000000000000..0786c345654d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.HP.out @@ -0,0 +1,16 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + diff --git a/contrib/libxo/tests/core/saved/test_11.J.err b/contrib/libxo/tests/core/saved/test_11.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.J.err diff --git a/contrib/libxo/tests/core/saved/test_11.J.out b/contrib/libxo/tests/core/saved/test_11.J.out new file mode 100644 index 000000000000..a574bbba921e --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.J.out @@ -0,0 +1,17 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + +{"__version": "3.1.4", "top": {}} diff --git a/contrib/libxo/tests/core/saved/test_11.JP.err b/contrib/libxo/tests/core/saved/test_11.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.JP.err diff --git a/contrib/libxo/tests/core/saved/test_11.JP.out b/contrib/libxo/tests/core/saved/test_11.JP.out new file mode 100644 index 000000000000..f82139be8779 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.JP.out @@ -0,0 +1,22 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + +{ + "__version": "3.1.4", + "top": { + + } +} diff --git a/contrib/libxo/tests/core/saved/test_11.JPu.err b/contrib/libxo/tests/core/saved/test_11.JPu.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.JPu.err diff --git a/contrib/libxo/tests/core/saved/test_11.JPu.out b/contrib/libxo/tests/core/saved/test_11.JPu.out new file mode 100644 index 000000000000..f82139be8779 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.JPu.out @@ -0,0 +1,22 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + +{ + "__version": "3.1.4", + "top": { + + } +} diff --git a/contrib/libxo/tests/core/saved/test_11.T.err b/contrib/libxo/tests/core/saved/test_11.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.T.err diff --git a/contrib/libxo/tests/core/saved/test_11.T.out b/contrib/libxo/tests/core/saved/test_11.T.out new file mode 100644 index 000000000000..0786c345654d --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.T.out @@ -0,0 +1,16 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + diff --git a/contrib/libxo/tests/core/saved/test_11.X.err b/contrib/libxo/tests/core/saved/test_11.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.X.err diff --git a/contrib/libxo/tests/core/saved/test_11.X.out b/contrib/libxo/tests/core/saved/test_11.X.out new file mode 100644 index 000000000000..5c279b73b151 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.X.out @@ -0,0 +1,17 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + +<top version="3.1.4"></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_11.XP.err b/contrib/libxo/tests/core/saved/test_11.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.XP.err diff --git a/contrib/libxo/tests/core/saved/test_11.XP.out b/contrib/libxo/tests/core/saved/test_11.XP.out new file mode 100644 index 000000000000..02765614e9ab --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_11.XP.out @@ -0,0 +1,18 @@ +{{<14>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-status [animal-status@42 animal="snake" state="loose"] The snake is loose}} +{{test-program: }} +{{The snake is loose}} + +{{<22>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-consumed [animal-consumed@42 animal="snake" pet="hamster"] My snake ate your hamster}} +{{test-program: }} +{{My snake ate your hamster}} + +{{<29>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 animal-talk [animal-talk@42 count="1" animal="owl" quote="\"e=m\\c[2\]\""] 1 owl said "e=m\c[2]"}} +{{test-program: }} +{{1 owl said "e=m\c[2]"}} + +{{<165>1 2015-06-23T13:47:09.123-0500 worker-host test-program 222 ID47 [ID47@32473 iut="3" event-source="application" event-id="1011"] An application 1011 log entry}} +{{test-program: }} +{{An application 1011 log entry}} + +<top version="3.1.4"> +</top> diff --git a/contrib/libxo/tests/core/saved/test_12.E.err b/contrib/libxo/tests/core/saved/test_12.E.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.E.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.E.out b/contrib/libxo/tests/core/saved/test_12.E.out new file mode 100644 index 000000000000..414311499fee --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.E.out @@ -0,0 +1,95 @@ +op create: [test] [] [0] +op open_container: [top] [] [0x4040010] +op open_container: [data] [] [0x4040010] +op string: [animal] [fish] [0] +op string: [animal] [fish] [0] +op open_list: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op close_instance: [thing] [] [0] +op open_instance: [thing] [] [0x4040010] +op string: [name] [thing] [0x80] +op string: [color] [green] [0] +op content: [time] [2:15] [0] +op string: [hand] [left] [0] +op string: [color] [blue] [0] +op content: [time] [3:45] [0] +op open_container: [2by4] [] [0x4040010] +op string: [4x4] [truck] [0] +op string: [2morrow] [tomorrow] [0] +op close_container: [2by4] [] [0] +op close_instance: [thing] [] [0] +op close_list: [thing] [] [0] +op close_container: [data] [] [0] +op close_container: [top] [] [0] +op finish: [] [] [0] +op flush: [] [] [0] diff --git a/contrib/libxo/tests/core/saved/test_12.H.err b/contrib/libxo/tests/core/saved/test_12.H.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.H.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.H.out b/contrib/libxo/tests/core/saved/test_12.H.out new file mode 100644 index 000000000000..86f0b3476dfa --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.H.out @@ -0,0 +1 @@ +<div class="line"><div class="text color-fg-red color-bg-green">Merry XMas!!</div></div><div class="line"><div class="text">One </div><div class="data color-fg-yellow color-bg-blue" data-tag="animal">fish</div><div class="text">, Two </div><div class="data color-fg-green color-bg-yellow" data-tag="animal">fish</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">The </div><div class="data color-fg-red" data-tag="name">thing</div><div class="text"> is </div><div class="data color-fg-green" data-tag="color">green</div><div class="text"> til </div><div class="data" data-tag="time">02:15</div></div><div class="line"><div class="text">My </div><div class="data color-fg-red" data-tag="hand">left</div><div class="text"> hand is </div><div class="data color-fg-blue" data-tag="color">blue</div><div class="text"> til </div><div class="data" data-tag="time">03:45</div></div><div class="line"><div class="text">There is </div><div class="data" data-tag="4x4">truck</div><div class="text"> in </div><div class="data" data-tag="2morrow">tomorrow</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_12.HIPx.err b/contrib/libxo/tests/core/saved/test_12.HIPx.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.HIPx.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.HIPx.out b/contrib/libxo/tests/core/saved/test_12.HIPx.out new file mode 100644 index 000000000000..a5588c14493b --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.HIPx.out @@ -0,0 +1,175 @@ +<div class="line"> + <div class="text color-fg-red color-bg-green">Merry XMas!!</div> +</div> +<div class="line"> + <div class="text">One </div> + <div class="data color-fg-yellow color-bg-blue" data-tag="animal" data-xpath="/top/data/animal">fish</div> + <div class="text">, Two </div> + <div class="data color-fg-green color-bg-yellow" data-tag="animal" data-xpath="/top/data/animal">fish</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name" data-xpath="/top/data/thing/name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand" data-xpath="/top/data/thing[name = 'thing']/hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color" data-xpath="/top/data/thing[name = 'thing']/color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time" data-xpath="/top/data/thing[name = 'thing']/time">03:45</div> +</div> +<div class="line"> + <div class="text">There is </div> + <div class="data" data-tag="4x4" data-xpath="/top/data/thing[name = 'thing']/2by4/4x4">truck</div> + <div class="text"> in </div> + <div class="data" data-tag="2morrow" data-xpath="/top/data/thing[name = 'thing']/2by4/2morrow">tomorrow</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_12.HP.err b/contrib/libxo/tests/core/saved/test_12.HP.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.HP.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.HP.out b/contrib/libxo/tests/core/saved/test_12.HP.out new file mode 100644 index 000000000000..f0b04abf3397 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.HP.out @@ -0,0 +1,175 @@ +<div class="line"> + <div class="text color-fg-red color-bg-green">Merry XMas!!</div> +</div> +<div class="line"> + <div class="text">One </div> + <div class="data color-fg-yellow color-bg-blue" data-tag="animal">fish</div> + <div class="text">, Two </div> + <div class="data color-fg-green color-bg-yellow" data-tag="animal">fish</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">The </div> + <div class="data color-fg-red" data-tag="name">thing</div> + <div class="text"> is </div> + <div class="data color-fg-green" data-tag="color">green</div> + <div class="text"> til </div> + <div class="data" data-tag="time">02:15</div> +</div> +<div class="line"> + <div class="text">My </div> + <div class="data color-fg-red" data-tag="hand">left</div> + <div class="text"> hand is </div> + <div class="data color-fg-blue" data-tag="color">blue</div> + <div class="text"> til </div> + <div class="data" data-tag="time">03:45</div> +</div> +<div class="line"> + <div class="text">There is </div> + <div class="data" data-tag="4x4">truck</div> + <div class="text"> in </div> + <div class="data" data-tag="2morrow">tomorrow</div> +</div> diff --git a/contrib/libxo/tests/core/saved/test_12.J.err b/contrib/libxo/tests/core/saved/test_12.J.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.J.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.J.out b/contrib/libxo/tests/core/saved/test_12.J.out new file mode 100644 index 000000000000..25a2416195a9 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.J.out @@ -0,0 +1 @@ +{"top": {"data": {"animal":"fish","animal":"fish", "thing": [{"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45"}, {"name":"thing","color":"green","time":"2:15","hand":"left","color":"blue","time":"3:45", "2by4": {"4x4":"truck","2morrow":"tomorrow"}}]}}} diff --git a/contrib/libxo/tests/core/saved/test_12.JP.err b/contrib/libxo/tests/core/saved/test_12.JP.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.JP.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.JP.out b/contrib/libxo/tests/core/saved/test_12.JP.out new file mode 100644 index 000000000000..0095d8dcc59a --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.JP.out @@ -0,0 +1,94 @@ +{ + "top": { + "data": { + "animal": "fish", + "animal": "fish", + "thing": [ + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45", + "2by4": { + "4x4": "truck", + "2morrow": "tomorrow" + } + } + ] + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_12.JPu.err b/contrib/libxo/tests/core/saved/test_12.JPu.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.JPu.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.JPu.out b/contrib/libxo/tests/core/saved/test_12.JPu.out new file mode 100644 index 000000000000..0095d8dcc59a --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.JPu.out @@ -0,0 +1,94 @@ +{ + "top": { + "data": { + "animal": "fish", + "animal": "fish", + "thing": [ + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45" + }, + { + "name": "thing", + "color": "green", + "time": "2:15", + "hand": "left", + "color": "blue", + "time": "3:45", + "2by4": { + "4x4": "truck", + "2morrow": "tomorrow" + } + } + ] + } + } +} diff --git a/contrib/libxo/tests/core/saved/test_12.T.err b/contrib/libxo/tests/core/saved/test_12.T.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.T.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.T.out b/contrib/libxo/tests/core/saved/test_12.T.out new file mode 100644 index 000000000000..42ee933808d7 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.T.out @@ -0,0 +1,23 @@ +[31;42mMerry XMas!![0m +One [33;44mfish[0m, Two [32;43mfish[0m +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +The [31mthing[0m is [32mgreen[0m til 02:15 +My [31mleft[0m hand is [34mblue[0m til 03:45 +There is truck in tomorrow diff --git a/contrib/libxo/tests/core/saved/test_12.X.err b/contrib/libxo/tests/core/saved/test_12.X.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.X.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.X.out b/contrib/libxo/tests/core/saved/test_12.X.out new file mode 100644 index 000000000000..072444615c79 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.X.out @@ -0,0 +1 @@ +<top><data><animal>fish</animal><animal>fish</animal><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time></thing><thing><name>thing</name><color>green</color><time>2:15</time><hand>left</hand><color>blue</color><time>3:45</time><_2by4><_4x4>truck</_4x4><_2morrow>tomorrow</_2morrow></_2by4></thing></data></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/core/saved/test_12.XP.err b/contrib/libxo/tests/core/saved/test_12.XP.err new file mode 100644 index 000000000000..6e563c3c236c --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.XP.err @@ -0,0 +1,4 @@ +test_12: invalid XML tag name: '2by4' +test_12: invalid XML tag name: '4x4' +test_12: invalid XML tag name: '2morrow' +test_12: invalid XML tag name: '2by4' diff --git a/contrib/libxo/tests/core/saved/test_12.XP.out b/contrib/libxo/tests/core/saved/test_12.XP.out new file mode 100644 index 000000000000..b3dc5992fbe9 --- /dev/null +++ b/contrib/libxo/tests/core/saved/test_12.XP.out @@ -0,0 +1,90 @@ +<top> + <data> + <animal>fish</animal> + <animal>fish</animal> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + </thing> + <thing> + <name>thing</name> + <color>green</color> + <time>2:15</time> + <hand>left</hand> + <color>blue</color> + <time>3:45</time> + <_2by4> + <_4x4>truck</_4x4> + <_2morrow>tomorrow</_2morrow> + </_2by4> + </thing> + </data> +</top> diff --git a/contrib/libxo/tests/core/test_01.c b/contrib/libxo/tests/core/test_01.c new file mode 100644 index 000000000000..8311efbfc87c --- /dev/null +++ b/contrib/libxo/tests/core/test_01.c @@ -0,0 +1,263 @@ +/* + * Copyright (c) 2014-2019, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdlib.h> +#include <stdint.h> +#include <string.h> +#include <unistd.h> + +#include "xo.h" +#include "xo_encoder.h" + +int +main (int argc, char **argv) +{ + static char base_grocery[] = "GRO"; + static char base_hardware[] = "HRD"; + struct item { + const char *i_title; + int i_sold; + int i_instock; + int i_onorder; + const char *i_sku_base; + int i_sku_num; + }; + struct item list[] = { + { "gum", 1412, 54, 10, base_grocery, 415 }, + { "rope", 85, 4, 2, base_hardware, 212 }, + { "ladder", 0, 2, 1, base_hardware, 517 }, + { "bolt", 4123, 144, 42, base_hardware, 632 }, + { "water", 17, 14, 2, base_grocery, 2331 }, + { NULL, 0, 0, 0, NULL, 0 } + }; + struct item list2[] = { + { "fish", 1321, 45, 1, base_grocery, 533 }, + { NULL, 0, 0, 0, NULL, 0 } + }; + struct item *ip; + xo_info_t info[] = { + { "in-stock", "number", "Number of items in stock" }, + { "name", "string", "Name of the item" }, + { "on-order", "number", "Number of items on order" }, + { "sku", "string", "Stock Keeping Unit" }, + { "sold", "number", "Number of items sold" }, + { XO_INFO_NULL }, + }; + + char name[] = "test_01.test"; /* test trimming of xo_program */ + argv[0] = name; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "xml")) + xo_set_style(NULL, XO_STYLE_XML); + else if (xo_streq(argv[argc], "json")) + xo_set_style(NULL, XO_STYLE_JSON); + else if (xo_streq(argv[argc], "text")) + xo_set_style(NULL, XO_STYLE_TEXT); + else if (xo_streq(argv[argc], "html")) + xo_set_style(NULL, XO_STYLE_HTML); + else if (xo_streq(argv[argc], "pretty")) + xo_set_flags(NULL, XOF_PRETTY); + else if (xo_streq(argv[argc], "xpath")) + xo_set_flags(NULL, XOF_XPATH); + else if (xo_streq(argv[argc], "info")) + xo_set_flags(NULL, XOF_INFO); + else if (xo_streq(argv[argc], "error")) { + close(-1); + xo_err(1, "error detected"); + } + } + + xo_set_info(NULL, info, -1); + xo_set_flags(NULL, XOF_KEYS); + + xo_open_container_h(NULL, "top-level"); + + xo_emit("static {:type/ethernet} {:type/bridge} {:type/%4du} {:type/%3d}", + 18, 24); + + xo_emit("anchor {[:/%d}{:address/%p}..{:port/%u}{]:}\n", 18, NULL, 1); + xo_emit("anchor {[:18}{:address/%p}..{:port/%u}{]:}\n", NULL, 1); + xo_emit("anchor {[:/18}{:address/%p}..{:port/%u}{]:}\n", NULL, 1); + + xo_emit("df {:used-percent/%5.0f}{U:%%}\n", (double) 12); + + xo_emit("{e:kve_start/%#jx}", (uintmax_t) 0xdeadbeef); + xo_emit("{e:kve_end/%#jx}", (uintmax_t) 0xcabb1e); + + xo_emit("testing argument modifier {a:}.{a:}...\n", + "host", "my-box", "domain", "example.com"); + + xo_emit("testing argument modifier with encoding to {ea:}.{a:}...\n", + "host", "my-box", "domain", "example.com"); + + xo_emit("{La:} {a:}\n", "Label text", "label", "value"); + + const char *title = "My Title"; + xo_emit_field("T", title, "%s\n", NULL, NULL); + + xo_emit_field("Vt", "max-chaos", NULL, NULL, " very "); + xo_emit_field("V", "min-chaos", "%d", NULL, 42); + xo_emit_field("V", "some-chaos", "%d\n", "[%d]", 42); + + xo_attr("test-attr", "attr-value"); + xo_emit_field_h(NULL, ",leaf-list,quotes", "sku", "%s-%u", "%s-000-%u", + "gum", 1412); + + xo_emit("Connecting to {:host}.{:domain}...\n", "my-box", "example.com"); + + xo_attr("test", "value"); + xo_open_container("data"); + xo_open_list("item"); + xo_attr("test2", "value2"); + + xo_emit("{T:Item/%-10s}{T:Total Sold/%12s}{T:In Stock/%12s}" + "{T:On Order/%12s}{T:SKU/%5s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + xo_attr("test3", "value3"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}" + "{k:name/%-10s/%s}{n:sold/%12u/%u}{:in-stock/%12u/%u}" + "{:on-order/%12u/%u}{qkd:sku/%5s-000-%u/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num, + ip->i_title, ip->i_sold, ip->i_instock, ip->i_onorder, + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_emit("\n\n"); + + xo_open_container("data2"); + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}", ip->i_sku_base, ip->i_sku_num); + xo_emit("{L:Item} '{k:name/%s}':\n", ip->i_title); + xo_emit("{P: }{L:Total sold}: {n:sold/%u%s}\n", + ip->i_sold, ip->i_sold ? ".0" : ""); + xo_emit("{P: }{Lcw:In stock}{:in-stock/%u}\n", ip->i_instock); + xo_emit("{P: }{Lcw:On order}{:on-order/%u}\n", ip->i_onorder); + xo_emit("{P: }{L:SKU}: {qkd:sku/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data2"); + + xo_open_container("data3"); + xo_open_list("item"); + + for (ip = list2; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}", ip->i_sku_base, ip->i_sku_num); + xo_emit("{L:Item} '{k:name/%s}':\n", ip->i_title); + xo_emit("{P: }{L:Total sold}: {n:sold/%u%s}\n", + ip->i_sold, ip->i_sold ? ".0" : ""); + xo_emit("{P: }{Lcw:In stock}{:in-stock/%u}\n", ip->i_instock); + xo_emit("{P: }{Lcw:On order}{:on-order/%u}\n", ip->i_onorder); + xo_emit("{P: }{L:SKU}: {qkd:sku/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data3"); + + xo_open_container("data4"); + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_attr("test4", "value4"); + xo_emit("{Lwc:Item}{l:item}\n", ip->i_title); + } + + xo_close_list("item"); + xo_close_container("data4"); + + xo_attr("test", "value"); + xo_open_container("data"); + xo_open_list("item"); + xo_attr("test2", "value2"); + + xo_emit("{T:Item/%-10s}{T:Total Sold/%12s}{T:In Stock/%12s}" + "{T:On Order/%12s}{T:SKU/%5s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + xo_attr("test3", "value3"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}" + "{k:name/%-10s/%s}{n:sold/%12u/%u}", + ip->i_sku_base, ip->i_sku_num, + ip->i_title, ip->i_sold); + + if (ip->i_onorder < 5) + xo_emit("Extra: {:extra}", "special"); + + if (ip->i_instock & 1) + xo_emit("{:in-stock/%12u/%u}", ip->i_instock); + xo_emit("{:on-order/%12u/%u}", ip->i_onorder); + if (!(ip->i_instock & 1)) + xo_emit("{:in-stock/%12u/%u}", ip->i_instock); + + xo_emit("{qkd:sku/%5s-000-%u/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_emit("\n\n"); + + + xo_emit("X{P:}X", "epic fail"); + xo_emit("X{T:}X", "epic fail"); + xo_emit("X{N:}X", "epic fail"); + xo_emit("X{L:}X\n", "epic fail"); + + xo_emit("X{P: }X{Lwc:Cost}{:cost/%u}\n", 425); + xo_emit("X{P:/%30s}X{Lwc:Cost}{:cost/%u}\n", "", 455); + + xo_emit("{e:mode/%s}{e:mode_octal/%s} {t:links/%s} " + "{t:user/%s} {t:group/%s} \n", + "mode", "octal", "links", + "user", "group", "extra1", "extra2", "extra3"); + + xo_emit("{e:pre/%s}{t:links/%-*u}{t:post/%-*s}\n", "that", 8, 3, 8, "this"); + + xo_emit("{t:mode/%s}{e:mode_octal/%03o} {t:links/%*u} " + "{t:user/%-*s} {t:group/%-*s} \n", + "/some/file", (int) 0640, 8, 1, + 10, "user", 12, "group"); + + xo_close_container_h(NULL, "top-level"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_02.c b/contrib/libxo/tests/core/test_02.c new file mode 100644 index 000000000000..7591eb177f7a --- /dev/null +++ b/contrib/libxo/tests/core/test_02.c @@ -0,0 +1,163 @@ +/* + * Copyright (c) 2014-2019, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#include <string.h> + +#include "xo.h" +#include "xo_encoder.h" + +#include "xo_humanize.h" + +int +main (int argc, char **argv) +{ + xo_set_program("test_02"); + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "xml")) + xo_set_style(NULL, XO_STYLE_XML); + else if (xo_streq(argv[argc], "json")) + xo_set_style(NULL, XO_STYLE_JSON); + else if (xo_streq(argv[argc], "text")) + xo_set_style(NULL, XO_STYLE_TEXT); + else if (xo_streq(argv[argc], "html")) + xo_set_style(NULL, XO_STYLE_HTML); + else if (xo_streq(argv[argc], "pretty")) + xo_set_flags(NULL, XOF_PRETTY); + else if (xo_streq(argv[argc], "xpath")) + xo_set_flags(NULL, XOF_XPATH); + else if (xo_streq(argv[argc], "info")) + xo_set_flags(NULL, XOF_INFO); + } + + xo_set_flags(NULL, XOF_UNITS); /* Always test w/ this */ + xo_set_file(stdout); + + xo_open_container_h(NULL, "top"); + + xo_open_container("data"); + + xo_emit("{kt:name/%-*.*s}{eq:flags/0x%x}", + 5, 5, "em0", 34883); + + xo_emit("{d:/%-*.*s}{etk:name}{eq:flags/0x%x}", + 5, 5, "em0", "em0", 34883); + + xo_emit("We are {{emit}}{{ting}} some {:what}\n", "braces"); + + xo_message("abcdef"); + close(-1); + xo_message_e("abcdef"); + + xo_message("improper use of profanity; %s; %s", + "ten yard penalty", "first down"); + + xo_emit("length {:length/%6.6s}\n", "abcdefghijklmnopqrstuvwxyz"); + + close(-1); + xo_emit("close {:fd/%d} returned {:error/%m} {:test}\n", -1, "good"); + close(-1); + xo_emit("close {:fd/%d} returned {:error/%6.6m} {:test}\n", -1, "good"); + + + xo_message("improper use of profanity; %s; %s", + "ten yard penalty", "first down"); + + xo_emit(" {:lines/%7ju} {:words/%7ju} " + "{:characters/%7ju} {d:filename/%s}\n", + (uintmax_t) 20, (uintmax_t) 30, (uintmax_t) 40, "file"); + + int i; + for (i = 0; i < 5; i++) + xo_emit("{lw:bytes/%d}{Np:byte,bytes}\n", i); + + xo_emit("{Lc:Low\\/warn granularity}{P:\t}{:granularity-lw/%d}{Uw:/%sh}\n", + 155, "mA"); + + xo_emit("{:mbuf-current/%u}/{:mbuf-cache/%u}/{:mbuf-total/%u} " + "{N:mbufs <&> in use (current\\/cache\\/total)}\n", + 10, 20, 30); + + xo_emit("{:distance/%u}{Uw:miles} from {:location}\n", 50, "Boston"); + xo_emit("{:memory/%u}{U:k} left out of {:total/%u}{U:kb}\n", 64, 640); + xo_emit("{:memory/%u}{U:/%s} left out of {:total/%u}{U:/%s}\n", + 64, "k", 640, "kilobytes"); + + xo_emit("{,title:/before%safter:}\n", "working"); + + xo_emit("{,display,white,colon:some/%s}" + "{,value:ten/%ju}{,value:eleven/%ju}\n", + "string", (uintmax_t) 10, (uintmax_t) 11); + + xo_emit("{:unknown/%u} " + "{N:/packet%s here\\/there\\/everywhere}\n", + 1010, "s"); + + xo_emit("{:unknown/%u} " + "{,note:/packet%s here\\/there\\/everywhere}\n", + 1010, "s"); + + xo_emit("({[:/%d}{n:min/15}/{n:cur/20}/{:max/%d}{]:})\n", 30, 125); + xo_emit("({[:30}{:min/%u}/{:cur/%u}/{:max/%u}{]:})\n", 15, 20, 125); + xo_emit("({[:-30}{n:min/15}/{n:cur/20}/{n:max/125}{]:})\n"); + xo_emit("({[:}{:min/%u}/{:cur/%u}/{:max/%u}{]:/%d})\n", 15, 20, 125, -30); + + xo_emit("Humanize: {h:val1/%u}, {h,hn-space:val2/%u}, " + "{h,hn-decimal:val3/%u}, {h,hn-1000:val4/%u}, " + "{h,hn-decimal:val5/%u}\n", + 21, + 57 * 1024, + 96 * 1024 * 1024, + (42 * 1024 + 420) * 1024, + 1342172800); + + xo_open_list("flag"); + xo_emit("{lq:flag/one} {lq:flag/two} {lq:flag/three}\n"); + xo_close_list("flag"); + + xo_emit("{n:works/%s}\n", NULL); + + xo_emit("{e:empty-tag/}"); + xo_emit("1:{qt:t1/%*d} 2:{qt:t2/test%-*u} " + "3:{qt:t3/%10sx} 4:{qt:t4/x%-*.*s}\n", + 6, 1000, 8, 5000, "ten-long", 10, 10, "test"); + xo_emit("{E:this is an error}\n"); + xo_emit("{E:/%s more error%s}\n", "two", "s" ); + xo_emit("{W:this is an warning}\n"); + xo_emit("{W:/%s more warning%s}\n", "two", "s" ); + xo_emit("{L:/V1\\/V2 packet%s}: {:count/%u}\n", "s", 10); + + int test = 4; + xo_emit("{:test/%04d} {L:/tr%s}\n", test, (test == 1) ? "y" : "ies"); + + xo_message("improper use of profanity; %s; %s", + "ten yard penalty", "first down"); + + xo_error("Shut 'er down, Clancey! She's a-pumpin' mud! <>!,\"!<>\n"); + xo_error("err message (%d)", 1); + xo_error("err message (%d)\n", 2); + xo_errorn("err message (%d)", 1); + xo_errorn("err message (%d)\n", 2); + + xo_close_container("data"); + + xo_close_container_h(NULL, "top"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_03.c b/contrib/libxo/tests/core/test_03.c new file mode 100644 index 000000000000..67d7be3dfce2 --- /dev/null +++ b/contrib/libxo/tests/core/test_03.c @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#include "xo.h" +#include "xo_encoder.h" + +xo_info_t info[] = { + { "employee", "object", "Employee data" }, + { "first-name", "string", "First name of employee" }, + { "last-name", "string", "Last name of employee" }, + { "department", "number", "Department number" }, +}; +int info_count = (sizeof(info) / sizeof(info[0])); + +int +main (int argc, char **argv) +{ + unsigned opt_count = 1; + unsigned opt_extra = 0; + + struct employee { + const char *e_first; + const char *e_last; + unsigned e_dept; + } employees[] = { + { "Terry", "Jones", 660 }, + { "Leslie", "Patterson", 341 }, + { "Ashley", "Smith", 1440 }, + { NULL, NULL } + }, *ep; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "count")) { + if (argv[argc + 1]) + opt_count = atoi(argv[++argc]); + } else if (xo_streq(argv[argc], "extra")) { + if (argv[argc + 1]) + opt_extra = atoi(argv[++argc]); + } + } + + xo_set_info(NULL, info, info_count); + + xo_open_container("employees"); + xo_open_list("employee"); + + xo_emit("[{:extra/%*s}]\n", opt_extra, ""); + + xo_emit("{T:/%13s} {T:/%5s} {T:/%6s} {T:/%7s} {T:/%8s} {T:Size(s)}\n", + "Type", "InUse", "MemUse", "HighUse", "Requests"); + xo_open_list("memory"); + xo_open_instance("memory"); + +#define PRIu64 "llu" +#define TO_ULL(_x) ((unsigned long long) _x) + xo_emit("{k:type/%13s} {:in-use/%5" PRIu64 "} " + "{:memory-use/%5" PRIu64 "}{U:K} {:high-use/%7s} " + "{:requests/%8" PRIu64 "} ", + "name", TO_ULL(12345), TO_ULL(54321), "-", TO_ULL(32145)); + + int first = 1, i; +#if 0 + xo_open_list("size"); + for (i = 0; i < 32; i++) { + if (!first) + xo_emit(","); + xo_emit("{l:size/%d}", 1 << (i + 4)); + first = 0; + } + xo_close_list("size"); +#endif + xo_close_instance("memory"); + xo_emit("\n"); + xo_close_list("memory"); + + while (opt_count-- != 0) { + for (ep = employees; ep->e_first; ep++) { + xo_open_instance("employee"); + xo_emit("{:first-name} {:last-name} works in " + "dept #{:department/%u}\n", + ep->e_first, ep->e_last, ep->e_dept); + xo_close_instance("employee"); + } + } + + xo_emit("done\n"); + + xo_close_list("employee"); + xo_close_container("employees"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_04.c b/contrib/libxo/tests/core/test_04.c new file mode 100644 index 000000000000..5e25302448b4 --- /dev/null +++ b/contrib/libxo/tests/core/test_04.c @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#include "xo.h" + +xo_info_t info[] = { + { "employee", "object", "Employee data" }, + { "first-name", "string", "First name of employee" }, + { "last-name", "string", "Last name of employee" }, + { "department", "number", "Department number" }, +}; +int info_count = (sizeof(info) / sizeof(info[0])); + +int +main (int argc, char **argv) +{ + struct employee { + const char *e_first; + const char *e_last; + unsigned e_dept; + } employees[] = { + { "Terry", "Jones", 660 }, + { "Leslie", "Patterson", 341 }, + { "Ashley", "Smith", 1440 }, + { NULL, NULL } + }, *ep = employees; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + xo_set_info(NULL, info, info_count); + + xo_open_container("employees"); + xo_open_list("employee"); + + xo_emit("{T:Last Name/%-12s}{T:First Name/%-14s}{T:Department/%s}\n"); + for ( ; ep->e_first; ep++) { + xo_open_instance("employee"); + xo_emit("{:first-name/%-12s/%s}{:last-name/%-14s/%s}" + "{:department/%8u/%u}\n", + ep->e_first, ep->e_last, ep->e_dept); + xo_close_instance("employee"); + } + + xo_close_list("employee"); + xo_close_container("employees"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_05.c b/contrib/libxo/tests/core/test_05.c new file mode 100644 index 000000000000..07de037edec6 --- /dev/null +++ b/contrib/libxo/tests/core/test_05.c @@ -0,0 +1,143 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <wchar.h> + +#include "xo.h" +#include "xo_config.h" + +#ifdef LIBXO_WCWIDTH +#include "xo_wcwidth.h" +#else /* LIBXO_WCWIDTH */ +#define xo_wcwidth(_x) wcwidth(_x) +#endif /* LIBXO_WCWIDTH */ + +xo_info_t info[] = { + { "employee", "object", "Employee data" }, + { "first-name", "string", "First name of employee" }, + { "last-name", "string", "Last name of employee" }, + { "department", "number", "Department number" }, + { "percent-time", "number", "Percentage of full & part time (%)" }, +}; +int info_count = (sizeof(info) / sizeof(info[0])); + +int +main (int argc, char **argv) +{ + struct employee { + const char *e_first; + const char *e_nic; + const char *e_last; + unsigned e_dept; + unsigned e_percent; + } employees[] = { + { "Jim", "რეგტ", "გთხოვთ ახ", 431, 90 }, + { "Terry", "<one", "Οὐχὶ ταὐτὰ παρίσταταί μοι Jones", 660, 90 }, + { "Leslie", "Les", "Patterson", 341,60 }, + { "Ashley", "Ash", "Meter & Smith", 1440, 40 }, + { "0123456789", "0123456789", "012345678901234567890", 1440, 40 }, + { "ახლა", "გაიარო", "საერთაშორისო", 123, 90 }, + { "෴ණ්ණ෴෴ණ්ණ෴", "Mick", + "෴ණ්ණ෴෴ණ්ණ෴෴ණ්ණ෴෴෴", 110, 20 }, + { NULL, NULL } + }, *ep = employees; + int rc, i; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + xo_set_info(NULL, info, info_count); + xo_set_flags(NULL, XOF_COLUMNS); + + xo_open_container("indian-languages"); + + xo_emit("{T:Sample text}\n"); + xo_emit("This sample text was taken from the Punjabi Wikipedia " + "article on Lahore and transliterated into the Latin script.\n"); + + xo_emit("{T:Gurmukhi:}\n"); + xo_emit("{:gurmukhi}\n", + "ਲਹੌਰ ਪਾਕਿਸਤਾਨੀ ਪੰਜਾਬ ਦੀ ਰਾਜਧਾਨੀ ਹੈ । ਲੋਕ ਗਿਣਤੀ ਦੇ ਨਾਲ ਕਰਾਚੀ ਤੋਂ ਬਾਅਦ ਲਹੌਰ ਦੂਜਾ ਸਭ ਤੋਂ ਵੱਡਾ ਸ਼ਹਿਰ ਹੈ । ਲਹੌਰ ਪਾਕਿਸਤਾਨ ਦਾ ਸਿਆਸੀ, ਰਹਤਲੀ ਤੇ ਪੜ੍ਹਾਈ ਦਾ ਗੜ੍ਹ ਹੈ ਅਤੇ ਇਸ ਲਈ ਇਹਨੂੰ ਪਾਕਿਸਤਾਨ ਦਾ ਦਿਲ ਵੀ ਕਿਹਾ ਜਾਂਦਾ ਹੈ । ਲਹੌਰ ਦਰਿਆ-ਏ-ਰਾਵੀ ਦੇ ਕੰਢੇ ਤੇ ਵਸਦਾ ਹੈ ਤੇ ਇਸਦੀ ਲੋਕ ਗਿਣਤੀ ਇੱਕ ਕਰੋੜ ਦੇ ਨੇੜੇ ਹੈ ।"); + + + xo_emit("{T:Shahmukhi:}\n"); + xo_emit("{:shahmukhi}\n", + "لہور پاکستانی پنجاب دا دارالحکومت اے۔ لوک گنتی دے نال کراچی توں بعد لہور دوجا سبھ توں وڈا شہر اے۔ لہور پاکستان دا سیاسی، رہتلی تے پڑھائی دا گڑھ اے تے اس لئی ایھنوں پاکستان دا دل وی کیھا جاندا اے۔ لہور دریاۓ راوی دے کنڈھے تے وسدا اے اسدی لوک گنتی اک کروڑ دے نیڑے اے ۔"); + + xo_emit("{T:Transliteration}:\n"); + xo_emit("{:tranliteration}\n", + "lahor pākistān panjāb dā dārul hakūmat ē. lōk giṇtī dē nāḷ karācī tō᷈ bāad lahor dūjā sab tō᷈ vaḍḍā shahr ē. lahor pākistān dā siāsī, rahtalī tē paṛā̀ī dā gā́ṛ ē tē is laī ihnū᷈ pākistān dā dil vī kehā jāndā ē. lahor dariāē rāvī dē kanḍē tē vasdā ē. isdī lōk giṇtī ikk karōṛ dē nēṛē ē."); + + xo_close_container("indian-languages"); + + xo_open_container("employees"); + + wchar_t wc[] = { L'෴', L'ණ', L'්', L'ණ', 0x17D2, L'෴', 0 }; + for (i = 0; wc[i]; i++) + xo_emit("Wide char: {lq:wc/%lc - %#lx - %d}\n", + wc[i], (unsigned long) wc[i], xo_wcwidth(wc[i])); + + wchar_t msg[] = { L'1', 0x034f, L'2', 0x20dd, 0 }; + for (i = 0; msg[i]; i++) + xo_emit("Wide char: {lq:wc/%lc - %#lx - %d}\n", + msg[i], (unsigned long) msg[i], xo_wcwidth((int) msg[i])); + xo_emit("Cool: [{:fancy/%ls}]\n", msg); + + xo_emit("Οὐχὶ ταὐτὰ παρίσταταί μοι {:v1/%s}, {:v2/%s}\n", + "γιγνώσκειν", "ὦ ἄνδρες ᾿Αθηναῖοι"); + + rc = xo_emit("გთხოვთ {:v1/%s} {:v2/%s}\n", + "ახლავე გაიაროთ რეგისტრაცია", + "Unicode-ის მეათე საერთაშორისო"); + xo_emit("{Twc:Width}{:width/%d}\n", rc); + + /* Okay, Sinhala is uber cool ... */ + rc = xo_emit("[{:sinhala}]\n", "෴ණ්ණ෴"); + xo_emit("{Twc:Width}{:width/%d}\n", rc); + + rc = xo_emit("[{:sinhala}]\n", "෴"); + xo_emit("{Twc:Width}{:width/%d}\n", rc); + + rc = xo_emit("[{:sinhala/%-4..4s/%s}]\n", "෴ණ්ණ෴෴ණ්ණ෴"); + xo_emit("{Twc:Width}{:width/%d}\n", rc); + + xo_emit("[{:not-sinhala/%-4..4s/%s}]\n", "123456"); + + rc = xo_emit("[{:tag/%s}]\n", "ර්ඝ"); + xo_emit("{Twc:Width}{:width/%d}\n", rc); + + xo_open_list("employee"); + + xo_emit("{T:First Name/%-25s}{T:Last Name/%-14s}" + "{T:/%-12s}{T:Time (%)}\n", "Department"); + for ( ; ep->e_first; ep++) { + xo_open_instance("employee"); + xo_emit("{[:-25}{:first-name/%s} ({:nic-name/\"%s\"}){]:}" + "{:last-name/%-14..14s/%s}" + "{:department/%8u}{:percent-time/%8u}\n", + ep->e_first, ep->e_nic, ep->e_last, ep->e_dept, ep->e_percent); + if (ep->e_percent > 50) { + xo_attr("full-time", "%s", "honest & for true"); + xo_emit("{e:benefits/%s}", "full"); + } + xo_close_instance("employee"); + } + + xo_close_list("employee"); + xo_close_container("employees"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_06.c b/contrib/libxo/tests/core/test_06.c new file mode 100644 index 000000000000..82baab85d05a --- /dev/null +++ b/contrib/libxo/tests/core/test_06.c @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#include "xo.h" + +xo_info_t info[] = { + { "employee", "object", "Employee data" }, + { "first-name", "string", "First name of employee" }, + { "last-name", "string", "Last name of employee" }, + { "department", "number", "Department number" }, +}; +int info_count = (sizeof(info) / sizeof(info[0])); + +int +main (int argc, char **argv) +{ + struct employee { + const char *e_first; + const char *e_last; + unsigned e_dept; + } employees[] = { + { "Terry", "Jones", 660 }, + { "Leslie", "Patterson", 341 }, + { "Ashley", "Smith", 1440 }, + { NULL, NULL } + }, *ep = employees; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + xo_set_info(NULL, info, info_count); + + xo_set_flags(NULL, XOF_DTRT); + + xo_open_container("employees"); + xo_open_list("employee"); + + for ( ; ep->e_first; ep++) { + xo_open_instance("employee"); + xo_emit("{:first-name} {:last-name} works in dept #{:department/%u}\n", + ep->e_first, ep->e_last, ep->e_dept); + xo_close_instance_d(); + } + + xo_close_list_d(); + xo_close_container_d(); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_07.c b/contrib/libxo/tests/core/test_07.c new file mode 100644 index 000000000000..5b1ed57292a2 --- /dev/null +++ b/contrib/libxo/tests/core/test_07.c @@ -0,0 +1,97 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +#include "xo.h" + +xo_info_t info[] = { + { "employee", "object", "Employee data" }, + { "first-name", "string", "First name of employee" }, + { "last-name", "string", "Last name of employee" }, + { "department", "number", "Department number" }, + { "percent-time", "number", "Percentage of full & part time (%)" }, +}; +int info_count = (sizeof(info) / sizeof(info[0])); + +int +main (int argc, char **argv) +{ + struct employee { + const char *e_first; + const char *e_nic; + const char *e_last; + unsigned e_dept; + unsigned e_percent; + } employees[] = { + { "Jim", "რეგტ", "გთხოვთ ახ", 431, 90 }, + { "Terry", "<one", "Οὐχὶ ταὐτὰ παρίσταταί μοι Jones", 660, 90 }, + { "Leslie", "Les", "Patterson", 341,60 }, + { "Ashley", "Ash", "Meter & Smith", 1440, 40 }, + { "0123456789", "0123456789", "012345678901234567890", 1440, 40 }, + { "ახლა", "გაიარო", "საერთაშორისო", 123, 90 }, + { NULL, NULL } + }, *ep = employees; + int rc; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + xo_set_info(NULL, info, info_count); + xo_set_flags(NULL, XOF_COLUMNS); + + xo_open_container("employees"); + + xo_open_list("test"); + xo_open_instance("test"); + xo_emit("{ek:filename/%s}", NULL); + xo_close_instance("test"); + xo_close_list("test"); + + rc = xo_emit("Οὐχὶ ταὐτὰ παρίσταταί μοι {:v1/%s}, {:v2/%s}\n", + "γιγνώσκειν", "ὦ ἄνδρες ᾿Αθηναῖοι"); + rc = xo_emit("{:columns/%d}\n", rc); + xo_emit("{:columns/%d}\n", rc); + + rc = xo_emit("გთხოვთ {:v1/%s} {:v2/%s}\n", + "ახლავე გაიაროთ რეგისტრაცია", + "Unicode-ის მეათე საერთაშორისო"); + xo_emit("{:columns/%d}\n", rc); + + + rc = xo_emit("{T:First Name/%-25s}{T:Last Name/%-14s}" + "{T:/%-12s}{T:Time (%)}\n", "Department"); + xo_emit("{:columns/%d}\n", rc); + + xo_open_list("employee"); + for ( ; ep->e_first; ep++) { + xo_open_instance("employee"); + rc = xo_emit("{[:-25}{:first-name/%s} ({:nic-name/\"%s\"}){]:}" + "{:last-name/%-14..14s/%s}" + "{:department/%8u/%u}{:percent-time/%8u/%u}\n", + ep->e_first, ep->e_nic, ep->e_last, ep->e_dept, ep->e_percent); + xo_emit("{:columns/%d}\n", rc); + if (ep->e_percent > 50) { + xo_attr("full-time", "%s", "honest & for true"); + xo_emit("{e:benefits/%s}", "full"); + } + xo_close_instance("employee"); + } + + xo_close_list("employee"); + xo_close_container("employees"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_08.c b/contrib/libxo/tests/core/test_08.c new file mode 100644 index 000000000000..b82a7c1dfcbc --- /dev/null +++ b/contrib/libxo/tests/core/test_08.c @@ -0,0 +1,158 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2015 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <errno.h> + +#include "xo.h" +#include "xo_encoder.h" + +int +main (int argc, char **argv) +{ + struct item { + const char *i_title; + int i_count; + }; + struct item list[] = { + { "gum", 1412 }, + { "rope", 85 }, + { "ladder", 0 }, + { "bolt", 4123 }, + { "water", 17 }, + { NULL, 0 } + }; + struct item *ip; + int i; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "xml")) + xo_set_style(NULL, XO_STYLE_XML); + else if (xo_streq(argv[argc], "json")) + xo_set_style(NULL, XO_STYLE_JSON); + else if (xo_streq(argv[argc], "text")) + xo_set_style(NULL, XO_STYLE_TEXT); + else if (xo_streq(argv[argc], "html")) + xo_set_style(NULL, XO_STYLE_HTML); + else if (xo_streq(argv[argc], "pretty")) + xo_set_flags(NULL, XOF_PRETTY); + else if (xo_streq(argv[argc], "xpath")) + xo_set_flags(NULL, XOF_XPATH); + else if (xo_streq(argv[argc], "info")) + xo_set_flags(NULL, XOF_INFO); + else if (xo_streq(argv[argc], "error")) { + close(-1); + xo_err(1, "error detected"); + } + } + + xo_set_flags(NULL, XOF_KEYS); + xo_set_program("test"); + + xo_open_container_h(NULL, "top"); + + xo_open_container("data"); + xo_open_container("contents"); + xo_open_list("item"); + + xo_emit("{T:Item/%-10s}{T:Count/%12s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{k:name/%-10s/%s}{n:count/%12u/%u}\n", + ip->i_title, ip->i_count); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("contents"); + xo_close_container("data"); + + xo_emit("\n\n"); + + xo_open_container("data2"); + xo_open_container("contents"); + + xo_emit("{T:Item/%-10s}{T:Count/%12s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{k:name/%-10s/%s}{n:count/%12u/%u}\n", + ip->i_title, ip->i_count); + } + + xo_close_container("data2"); + + xo_emit("\n\n"); + + xo_open_container("data3"); + xo_open_marker("m1"); + xo_open_container("contents"); + + xo_emit("{T:Item/%-10s}{T:Count/%12s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{k:name/%-10s/%s}{n:count/%12u/%u}\n", + ip->i_title, ip->i_count); + } + + xo_close_container("data3"); /* warn: fails at marker 'm1' */ + xo_emit("{:test}", "one"); + + xo_close_marker("m1"); + xo_close_container("data3"); /* this one works, post-marker */ + + xo_emit("\n\n"); + + xo_open_container("data4"); + xo_open_marker("m1"); + xo_open_container("contents"); + + xo_emit("{T:Item/%-10s}{T:Count/%12s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{k:name/%-10s/%s}{n:count/%12u/%u}\n", + ip->i_title, ip->i_count); + + xo_open_marker("m2"); + for (i = 0; i < 3; i++) { + xo_open_instance("sub"); + xo_emit("{Lwc:/Name}{:name/%d} + 1 = {:next/%d}\n", i, i + 1); + xo_close_container("data4"); /* warn: fails at marker 'm2' */ + } + xo_close_marker("m2"); + xo_emit("{Lwc:/Last}{:last/%d}\n", i); + } + + xo_close_container("data4"); /* warn: fails at marker 'm1' */ + xo_emit("{:test}", "one"); + + xo_emit("\n\n"); + + xo_close_container_h(NULL, "top"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_09.c b/contrib/libxo/tests/core/test_09.c new file mode 100644 index 000000000000..f564d6e72914 --- /dev/null +++ b/contrib/libxo/tests/core/test_09.c @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2015 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <errno.h> + +#include "xo.h" +#include "xo_encoder.h" + +int +main (int argc, char **argv) +{ + struct item { + const char *i_title; + int i_count; + }; + struct item list[] = { + { "gum", 1412 }, + { "rope", 85 }, + { "ladder", 0 }, + { "bolt", 4123 }, + { "water", 17 }, + { NULL, 0 } + }; + struct item *ip; + int i; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "xml")) + xo_set_style(NULL, XO_STYLE_XML); + else if (xo_streq(argv[argc], "json")) + xo_set_style(NULL, XO_STYLE_JSON); + else if (xo_streq(argv[argc], "text")) + xo_set_style(NULL, XO_STYLE_TEXT); + else if (xo_streq(argv[argc], "html")) + xo_set_style(NULL, XO_STYLE_HTML); + else if (xo_streq(argv[argc], "pretty")) + xo_set_flags(NULL, XOF_PRETTY); + else if (xo_streq(argv[argc], "xpath")) + xo_set_flags(NULL, XOF_XPATH); + else if (xo_streq(argv[argc], "info")) + xo_set_flags(NULL, XOF_INFO); + else if (xo_streq(argv[argc], "error")) { + close(-1); + xo_err(1, "error detected"); + } + } + + xo_set_flags(NULL, XOF_KEYS); + xo_set_program("test"); + + xo_open_container_h(NULL, "top"); + + xo_open_container("data"); + xo_open_container("contents"); + + xo_emit("{T:Item/%-10s}{T:Count/%12s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_emit("Name: {l:name/%-10s/%s}\n", ip->i_title); + } + + xo_close_container("contents"); + + xo_emit("\n\n"); + xo_open_container("contents"); + + xo_emit("{T:Item/%-10s}{T:Count/%12s}\n"); + + for (ip = list; ip->i_title; ip++) { + xo_emit("Name: {l:item/%-10s/%s}\n", ip->i_title); + } + + xo_close_container("contents"); + + xo_emit("\n\n"); + + xo_open_container("contents"); + xo_emit("{T:Test/%-10s}{T:Three/%12s}\n"); + + xo_open_list("item"); + for (ip = list; ip->i_title; ip++) { + xo_emit("Name: {l:item/%-10s/%s}\n", ip->i_title); + } + xo_emit("{Lwc:/Total:}{:total}\n", "six"); + + xo_emit("{:one}", "one"); + xo_emit("{l:two}", "two"); + xo_emit("{:three}", "three"); + + + xo_close_container("contents"); + + xo_emit("\n\n"); + + xo_close_container_h(NULL, "top"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_10.c b/contrib/libxo/tests/core/test_10.c new file mode 100644 index 000000000000..a53ddecdf747 --- /dev/null +++ b/contrib/libxo/tests/core/test_10.c @@ -0,0 +1,213 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <errno.h> +#include <ctype.h> + +#include "xo.h" +#include "xo_encoder.h" + +int +main (int argc, char **argv) +{ + static char base_grocery[] = "GRO"; + static char base_hardware[] = "HRD"; + struct item { + const char *i_title; + int i_sold; + int i_instock; + int i_onorder; + const char *i_sku_base; + int i_sku_num; + }; + struct item list[] = { + { "gum", 1412, 54, 10, base_grocery, 415 }, + { "rope", 85, 4, 2, base_hardware, 212 }, + { "ladder", 0, 2, 1, base_hardware, 517 }, + { "bolt", 4123, 144, 42, base_hardware, 632 }, + { "water", 17, 14, 2, base_grocery, 2331 }, + { NULL, 0, 0, 0, NULL, 0 } + }; + struct item list2[] = { + { "fish", 1321, 45, 1, base_grocery, 533 }, + { NULL, 0, 0, 0, NULL, 0 } + }; + struct item *ip; + xo_info_t info[] = { + { "in-stock", "number", "Number of items in stock" }, + { "name", "string", "Name of the item" }, + { "on-order", "number", "Number of items on order" }, + { "sku", "string", "Stock Keeping Unit" }, + { "sold", "number", "Number of items sold" }, + { NULL, NULL, NULL }, + }; + int info_count = (sizeof(info) / sizeof(info[0])) - 1; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "xml")) + xo_set_style(NULL, XO_STYLE_XML); + else if (xo_streq(argv[argc], "json")) + xo_set_style(NULL, XO_STYLE_JSON); + else if (xo_streq(argv[argc], "text")) + xo_set_style(NULL, XO_STYLE_TEXT); + else if (xo_streq(argv[argc], "html")) + xo_set_style(NULL, XO_STYLE_HTML); + else if (xo_streq(argv[argc], "pretty")) + xo_set_flags(NULL, XOF_PRETTY); + else if (xo_streq(argv[argc], "xpath")) + xo_set_flags(NULL, XOF_XPATH); + else if (xo_streq(argv[argc], "info")) + xo_set_flags(NULL, XOF_INFO); + else if (xo_streq(argv[argc], "error")) { + close(-1); + xo_err(1, "error detected"); + } + } + + xo_set_info(NULL, info, info_count); + xo_set_flags(NULL, XOF_KEYS); + + /* Normally one would use "XOF_COLOR_ALLOWED", but we want to force it */ + xo_set_flags(NULL, XOF_COLOR); + + xo_set_version("3.1.4"); + + xo_open_container_h(NULL, "top"); + + xo_attr("test", "value"); + xo_open_container("data"); + xo_open_list("item"); + xo_attr("test2", "value2"); + + static const char *colors[] = + { "blue", "green", "red", "yellow", "default", NULL }; + + int i; + for (i = 0; colors[i]; i++) { + if (i > 0) + xo_emit("{C:/bg-%s}", colors[i-1]); + xo_emit("{C:/fg-%s}{T:/%s}", colors[i], colors[i]); + } + xo_emit("{C:reset}\n"); + + xo_emit("{C:bold}{:data} {C:underline}{:data} {C:inverse}{:data} " + "{C:no-bold}{:data} {C:no-inverse}{:data} " + "{C:no-underline}{:data}\n", + "bold", "bold-ul", "triple", "inv-ul", "underline", "plain"); + + xo_emit("{T:Item/%-10s}{C:bold,underline}{T:Total Sold/%12s}{C:no-bold}" + "{T:In Stock/%12s}{C:/%s}" + "{T:On Order/%12s}{C:normal}{T:SKU/%5s}\n", "inverse"); + +#if 0 + xo_finish(); + return 0; +#endif + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + xo_attr("test3", "value3"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}" + "{k:name/%-10s/%s}{n:sold/%12u/%u}" + "{C:/%s}{:in-stock/%12u/%u}{C:normal}" + "{C:/fg-%s}{:on-order/%12u/%u}{C:/fg-default}" + "{qkd:sku/%5s-000-%u/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num, + ip->i_title, ip->i_sold, + (ip->i_instock < 5) ? "inverse" : "normal", ip->i_instock, + (ip->i_onorder > 5) ? "yellow" : "default", ip->i_onorder, + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_emit("\n\n"); + + xo_open_container("data"); + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}", ip->i_sku_base, ip->i_sku_num); + xo_emit("{L:Item} '{k:name/%s}':\n", ip->i_title); + xo_emit("{P: }{L:Total sold}: {n:sold/%u%s}\n", + ip->i_sold, ip->i_sold ? ".0" : ""); + xo_emit("{P: }{Lcw:In stock}{C:inverse}{:in-stock/%u}{C:}\n", + ip->i_instock); + xo_emit("{P: }{Lcw:On order}{:on-order/%u}\n", ip->i_onorder); + xo_emit("{P: }{L:SKU}: {qkd:sku/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_open_container("data"); + xo_open_list("item"); + + for (ip = list2; ip->i_title; ip++) { + xo_open_instance("item"); + + xo_emit("{keq:sku/%s-%u/%s-000-%u}", ip->i_sku_base, ip->i_sku_num); + xo_emit("{L:Item} '{k:name/%s}':\n", ip->i_title); + xo_emit("{P: }{C:bg-blue , fg-white, bold }{L:Total sold}: " + "{n:sold/%u%s}{C:}\n", + ip->i_sold, ip->i_sold ? ".0" : ""); + xo_emit("{P: }{Lcw:In stock}{:in-stock/%u}\n", ip->i_instock); + xo_emit("{P: }{Lcw:On order}{:on-order/%u}\n", ip->i_onorder); + xo_emit("{P: }{L:SKU}: {qkd:sku/%s-000-%u}\n", + ip->i_sku_base, ip->i_sku_num); + + xo_close_instance("item"); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_open_container("data"); + xo_open_list("item"); + + for (ip = list; ip->i_title; ip++) { + xo_attr("test4", "value4"); + xo_emit("{Lwc:Item}{l:item}\n", ip->i_title); + } + + xo_close_list("item"); + xo_close_container("data"); + + xo_emit("X{P:}X", "epic fail"); + xo_emit("X{T:}X", "epic fail"); + xo_emit("X{N:}X", "epic fail"); + xo_emit("X{L:}X\n", "epic fail"); + + xo_emit("X{P: }X{Lwc:Cost}{:cost/%u}\n", 425); + xo_emit("X{P:/%30s}X{Lwc:Cost}{:cost/%u}\n", "", 455); + + xo_close_container_h(NULL, "top"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_11.c b/contrib/libxo/tests/core/test_11.c new file mode 100644 index 000000000000..c4a76beb873b --- /dev/null +++ b/contrib/libxo/tests/core/test_11.c @@ -0,0 +1,110 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <errno.h> +#include <time.h> +#include <ctype.h> +#include <syslog.h> + +#include "xo.h" +#include "xo_encoder.h" + +void +test_syslog_open (void) +{ + printf("syslog open\n"); +} + +void +test_syslog_close (void) +{ + printf("syslog close\n"); +} + +void +test_syslog_send (const char *full_msg, const char *v0_hdr, + const char *text_only) +{ + printf("{{%s}}\n{{%s}}\n{{%s}}\n\n", full_msg, v0_hdr, text_only); +} + +int +main (int argc, char **argv) +{ + int unit_test = 1; + int fire = 0; + const char *tzone = "EST"; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "full")) + unit_test = 0; + else if (xo_streq(argv[argc], "fire")) + fire = 1; + else if (xo_streq(argv[argc], "tz")) + tzone = argv[++argc]; + } + + setenv("TZ", tzone, 1); + tzset(); + + if (!fire) { + xo_set_syslog_handler(test_syslog_open, test_syslog_send, + test_syslog_close); + } + + if (unit_test) { + xo_set_unit_test_mode(1); + xo_open_log("test-program", LOG_PERROR, 0); + } + + xo_set_version("3.1.4"); + xo_set_syslog_enterprise_id(42); /* SunOs */ + + xo_open_container_h(NULL, "top"); + + xo_syslog(LOG_INFO | LOG_KERN, "animal-status", + "The {:animal} is {:state}", "snake", "loose"); + xo_syslog(LOG_INFO | LOG_MAIL, "animal-consumed", + "My {:animal} ate your {:pet}", "snake", "hamster"); + xo_syslog(LOG_NOTICE | LOG_DAEMON, "animal-talk", + "{:count/%d} {:animal} said {:quote}", 1, "owl", "\"e=m\\c[2]\""); + + /* + <165>1 2003-10-11T22:14:15.003Z mymachine.example.com + evntslog - ID47 [exampleSDID@32473 iut="3" eventSource= + "Application" eventID="1011"] BOMAn application + event log entry... + + This example is modeled after Example 1. However, this time it + contains STRUCTURED-DATA, a single element with the value + "[exampleSDID@32473 iut="3" eventSource="Application" + eventID="1011"]". The MSG itself is "An application event log + entry..." The BOM at the beginning of MSG indicates UTF-8 encoding. + */ + + xo_set_syslog_enterprise_id(32473); + xo_syslog(LOG_LOCAL4 | LOG_NOTICE, "ID47", + "{e:iut/%u}An {:event-source} {:event-id/%u} log entry", + 3, "application", 1011); + + xo_close_container_h(NULL, "top"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/core/test_12.c b/contrib/libxo/tests/core/test_12.c new file mode 100644 index 000000000000..32af2d211857 --- /dev/null +++ b/contrib/libxo/tests/core/test_12.c @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2014, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> +#include <string.h> + +#include "xo_config.h" +#include "xo.h" +#include "xo_encoder.h" + +int +main (int argc, char **argv) +{ + int i, count = 10; + int mon = 0; + xo_emit_flags_t flags = XOEF_RETAIN; + int opt_color = 1; + + xo_set_program("test_12"); + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "xml")) + xo_set_style(NULL, XO_STYLE_XML); + else if (xo_streq(argv[argc], "json")) + xo_set_style(NULL, XO_STYLE_JSON); + else if (xo_streq(argv[argc], "text")) + xo_set_style(NULL, XO_STYLE_TEXT); + else if (xo_streq(argv[argc], "html")) + xo_set_style(NULL, XO_STYLE_HTML); + else if (xo_streq(argv[argc], "no-color")) + opt_color = 0; + else if (xo_streq(argv[argc], "pretty")) + xo_set_flags(NULL, XOF_PRETTY); + else if (xo_streq(argv[argc], "xpath")) + xo_set_flags(NULL, XOF_XPATH); + else if (xo_streq(argv[argc], "info")) + xo_set_flags(NULL, XOF_INFO); + else if (xo_streq(argv[argc], "no-retain")) + flags &= ~XOEF_RETAIN; + else if (xo_streq(argv[argc], "big")) { + if (argv[argc + 1]) + count = atoi(argv[++argc]); + } + } + + xo_set_flags(NULL, XOF_UNITS); /* Always test w/ this */ + if (opt_color) + xo_set_flags(NULL, XOF_COLOR); /* Force color output */ + xo_set_file(stdout); + + xo_open_container("top"); + xo_open_container("data"); + + xo_emit("{C:fg-red,bg-green}Merry XMas!!{C:}\n"); + + xo_emit("One {C:fg-yellow,bg-blue}{:animal}{C:}, " + "Two {C:fg-green,bg-yellow}{:animal}{C:}\n", + "fish", "fish"); + + const char *fmt1 = "The {C:fg-red}{k:name}{C:reset} is " + "{C:/fg-%s}{:color}{C:reset} til {:time/%02d:%02d}\n"; + const char *fmt2 = "My {C:fg-red}{:hand}{C:reset} hand is " + "{C:/fg-%s}{:color}{C:reset} til {:time/%02d:%02d}\n"; + + for (i = 0; i < count; i++) { + xo_open_instance("thing"); + xo_emit_f(flags, fmt1, "thing", "green", "green", 2, 15); + xo_emit_f(flags, fmt2, "left", "blue", "blue", 3, 45); + } + + xo_open_container("2by4"); + xo_emit("There is {:4x4} in {:2morrow}\n", "truck", "tomorrow"); + xo_close_container("2by4"); + + + xo_close_container("data"); + xo_close_container_h(NULL, "top"); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/gettext/Makefile.am b/contrib/libxo/tests/gettext/Makefile.am new file mode 100644 index 000000000000..2e6596aa876a --- /dev/null +++ b/contrib/libxo/tests/gettext/Makefile.am @@ -0,0 +1,223 @@ +# +# $Id$ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +AM_CFLAGS = \ + -I${top_srcdir} \ + -I${top_srcdir}/libxo \ + ${GETTEXT_CFLAGS} + +# Ick: maintained by hand! +TEST_CASES = \ +gt_01.c + +gt_01_test_SOURCES = gt_01.c + +# TEST_CASES := $(shell cd ${srcdir} ; echo *.c ) + +noinst_PROGRAMS = ${TEST_CASES:.c=.test} + +LDADD = \ + ${top_builddir}/libxo/libxo.la + +if HAVE_HUMANIZE_NUMBER +LDADD += -lutil +endif + +EXTRA_DIST = \ + ${TEST_CASES} \ + ${addprefix saved/, ${TEST_CASES:.c=.T.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.T.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.XP.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.XP.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.JP.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.JP.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HP.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HP.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.X.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.X.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.J.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.J.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.H.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.H.out}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HIPx.err}} \ + ${addprefix saved/, ${TEST_CASES:.c=.HIPx.out}} + +POT_FILES = \ + gt_01.pot \ + ldns.pot \ + strerror.pot + +PO_FILES = \ + po/pig_latin/gt_01.po \ + po/pig_latin/ldns.po \ + po/pig_latin/strerror.po + +EXTRA_DIST += ${POT_FILES} ${PO_FILES} + +S2O = | ${SED} '1,/@@/d' + +all: + +valgrind: + @echo '## Running the regression tests under Valgrind' + ${MAKE} CHECKER='valgrind -q' tests + +#TEST_TRACE = set -x ; + +TEST_ONE = \ + ${CHECKER} ./$$base.test --libxo:W$$fmt ${TEST_OPTS} \ + > out/$$base.$$fmt.out 2> out/$$base.$$fmt.err ; \ + ${DIFF} -Nu ${srcdir}/saved/$$base.$$fmt.out out/$$base.$$fmt.out ${S2O} ; \ + ${DIFF} -Nu ${srcdir}/saved/$$base.$$fmt.err out/$$base.$$fmt.err ${S2O} + +TEST_FORMATS = T XP JP HP X J H HIPx + +test tests: ${bin_PROGRAMS} build-mo-files + @${MKDIR} -p out + -@ ${TEST_TRACE} (for test in ${TEST_CASES} ; do \ + base=`${BASENAME} $$test .c` ; \ + (for fmt in ${TEST_FORMATS}; do \ + echo "... $$test ... $$fmt ..."; \ + ${TEST_ONE}; \ + true; \ + done) \ + done) + +one: + -@(test=${TEST_CASE}; data=${TEST_DATA}; ${TEST_ONE} ; true) + +accept: + -@(for test in ${TEST_CASES} ; do \ + base=`${BASENAME} $$test .c` ; \ + (for fmt in ${TEST_FORMATS}; do \ + echo "... $$test ... $$fmt ..."; \ + ${CP} out/$$base.$$fmt.out ${srcdir}/saved/$$base.$$fmt.out ; \ + ${CP} out/$$base.$$fmt.err ${srcdir}/saved/$$base.$$fmt.err ; \ + done) \ + done) + +.c.test: + $(AM_V_CC)$(LTCOMPILE) -MT $@ -MD -MP -MF $(DEPDIR)/$*.Tpo -o $@ $< + +CLEANFILES = ${TEST_CASES:.c=.test} +CLEANDIRS = out + +clean-local: + rm -rf ${CLEANDIRS} + +XGETTEXT = ${GETTEXT_BINDIR}/xgettext +MSGFMT = ${GETTEXT_BINDIR}/msgfmt -v +MSGMERGE = ${GETTEXT_BINDIR}/msgmerge +ECHO = echo +DB=set -x; +XOMSGMERGE = ${MSGMERGE} --no-wrap +XODIFF = ${DIFF} -bu + +LANGUAGES = \ + es \ + fr \ + pig_latin + +# ldns is fake; used only for a gettext domain +FAKE_FILES = ldns strerror +MO_BASE_FILES = ${TEST_CASES:.c=} ${FAKE_FILES} + +build-pot-files: + for file in ${TEST_CASES} ; do set -x ;\ + base=`${BASENAME} $$file .c` ; \ + ${XGETTEXT} --default-domain=$$base \ + --directory=${srcdir} --no-wrap \ + --add-comments --keyword=xo_emit --keyword=xo_emit_h \ + --keyword=xo_emit_warn \ + -C -E -n --foreign-user \ + -o $$base.pot.new $$base.c ; \ + done + +accept-pot-files: + for base in ${MO_BASE_FILES} ; do set -x ;\ + ${CP} $$base.pot.new ${srcdir}/$$base.pot ; \ + done + +merge-po-files: + for base in ${MO_BASE_FILES} ; do set -x ;\ + for lang in ${LANGUAGES} ; do \ + if [ -f po/$$lang/$$base.po ]; then \ + ${ECHO} "merging $$base.pot into po/$$lang/$$base.po ..." ; \ + if ${XOMSGMERGE} po/$$lang/$$base.po \ + ${srcdir}/$$base.pot \ + -o po/$$lang/$$base.new.po; then \ + ${MV} po/$$lang/$$base.po \ + po/$$lang/$$base.po.old ; \ + ${MV} po/$$lang/$$base.new.po \ + po/$$lang/$$base.po ; \ + else \ + echo "error: msgmerge for $$base failed"; \ + fi ; \ + elif [ -f ${srcdir}/po/$$lang/$$base.po ]; then \ + ${ECHO} "merging (srcdir) $$base.pot into po/$$lang/$$base.po ..." ; \ + if ${XOMSGMERGE} ${srcdir}/po/$$lang/$$base.po \ + ${srcdir}/$$base.pot \ + -o po/$$lang/$$base.new.po; then \ + ${MV} po/$$lang/$$base.po \ + po/$$lang/$$base.po.old ; \ + ${MV} po/$$lang/$$base.new.po \ + po/$$lang/$$base.po ; \ + else \ + echo "error: msgmerge for $$base failed"; \ + fi ; \ + fi ; \ + done ; \ + done + +accept-po-files: + @(for base in ${MO_BASE_FILES} ; do \ + for lang in ${LANGUAGES} ; do \ + if [ -f po/$$lang/$$base.po ]; then \ + ${MKDIR} -p ${srcdir}/po/$$lang ; \ + (${DB} ${CP} po/$$lang/$$base.po ${srcdir}/po/$$lang/$$base.po ); \ + fi ; \ + done ; \ + done) + +new-po-file: + @(for base in ${MO_BASE_FILES} ; do set -x ;\ + for lang in ${LANGUAGES} ; do \ + if [ ! -f po/$$lang/$$base.po ]; then \ + ${MKDIR} -p po/$$lang ; \ + (${DB} ${CP} $$base.pot po/$$lang/$$base.po ); \ + fi ; \ + done ; \ + done) + +diff: + @(for base in ${MO_BASE_FILES} ; do \ + if [ -f $$base.pot.new ] ; then \ + ${XODIFF} ${srcdir}/$$base.pot $$base.pot.new ; \ + fi ; \ + for lang in ${LANGUAGES} ; do \ + if [ -f po/$$lang/$$base.po ] ; then \ + ${XODIFF} ${srcdir}/po/$$lang/$$base.po po/$$lang/$$base.po ; \ + fi ; \ + done ; \ + done) + +mo build-mo-files: + @(for base in ${MO_BASE_FILES} ; do \ + for lang in ${LANGUAGES} ; do \ + ${MKDIR} -p po/$$lang/LC_MESSAGES ; \ + if [ -f po/$$lang/$$base.po ] ; then \ + (${DB} ${MSGFMT} -o po/$$lang/LC_MESSAGES/$$base.mo \ + po/$$lang/$$base.po ); \ + elif [ -f ${srcdir}/po/$$lang/$$base.po ]; then \ + (${DB} ${MSGFMT} -o po/$$lang/LC_MESSAGES/$$base.mo \ + ${srcdir}/po/$$lang/$$base.po ;) \ + fi ; \ + done ; \ + done) diff --git a/contrib/libxo/tests/gettext/gt_01.c b/contrib/libxo/tests/gettext/gt_01.c new file mode 100644 index 000000000000..2a06a306fc8b --- /dev/null +++ b/contrib/libxo/tests/gettext/gt_01.c @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, June 2015 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <errno.h> +#include <ctype.h> +#include <time.h> +#include <sys/time.h> +#include <sys/param.h> +#include <locale.h> +#include <libintl.h> + +#include "xo.h" +#include "xo_encoder.h" + +int +main (int argc, char **argv) +{ + static char domainname[] = "gt_01"; + static char path[MAXPATHLEN]; + const char *tzone = "EST"; + const char *lang = "pig_latin"; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + for (argc = 1; argv[argc]; argc++) { + if (xo_streq(argv[argc], "tz")) + tzone = argv[++argc]; + else if (xo_streq(argv[argc], "lang")) + lang = argv[++argc]; + else if (xo_streq(argv[argc], "po")) + strlcpy(path, argv[++argc], sizeof(path)); + } + + setenv("LANG", lang, 1); + setenv("TZ", tzone, 1); + + if (path[0] == 0) { + getcwd(path, sizeof(path)); + strlcat(path, "/po", sizeof(path)); + } + + setlocale(LC_ALL, ""); + bindtextdomain(domainname, path); + bindtextdomain("ldns", path); + bindtextdomain("strerror", path); + textdomain(domainname); + tzset(); + + xo_open_container("top"); + + xo_emit("{G:}Your {qg:adjective} {g:noun} is {g:verb} {qg:owner} {g:target}\n", + "flaming", "sword", "burning", "my", "couch"); + + xo_emit("{G:}The {qg:adjective} {g:noun} was {g:verb} {qg:owner} {g:target}\n", + "flaming", "sword", "burning", "my", "couch"); + + + int i; + for (i = 0; i < 5; i++) + xo_emit("{lw:bytes/%d}{Ngp:byte,bytes}\n", i); + + xo_emit("{G:}{L:total} {:total/%u}\n", 1234); + + xo_emit("{G:ldns}Received {:received/%zu} {Ngp:byte,bytes} " + "from {:from/%s}#{:port/%d} in {:time/%d} ms\n", + (size_t) 1234, "foop", 4321, 32); + + xo_emit("{G:}Received {:received/%zu} {Ngp:byte,bytes} " + "from {:from/%s}#{:port/%d} in {:time/%d} ms\n", + (size_t) 1234, "foop", 4321, 32); + + xo_emit("{G:/%s}Received {:received/%zu} {Ngp:byte,bytes} " + "from {:from/%s}#{:port/%d} in {:time/%d} ms\n", + "ldns", (size_t) 1234, "foop", 4321, 32); + + struct timeval tv; + tv.tv_sec = 1435085229; + tv.tv_usec = 123456; + + struct tm tm; + (void) gmtime_r(&tv.tv_sec, &tm); + + char date[64]; + strftime(date, sizeof(date), "%+", &tm); + + xo_emit("{G:}Only {:marzlevanes/%d} {Ngp:marzlevane,marzlevanes} " + "are functioning correctly\n", 3); + + xo_emit("{G:}Version {:version} {:date}\n", "1.2.3", date); + + errno = EACCES; + xo_emit_warn("{G:}Unable to {g:verb/objectulate} forward velociping"); + xo_emit_warn("{G:}{g:style/automatic} synchronization of {g:type/cardinal} " + "{g:target/grammeters} failed"); + xo_emit("{G:}{Lwcg:hydrocoptic marzlevanes}{:marzlevanes/%d}\n", 6); + + xo_emit("{G:}{Lwcg:Windings}{g:windings}\n", "lotus-o-delta"); + + xo_close_container("top"); + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/tests/gettext/gt_01.pot b/contrib/libxo/tests/gettext/gt_01.pot new file mode 100644 index 000000000000..1d09223ec786 --- /dev/null +++ b/contrib/libxo/tests/gettext/gt_01.pot @@ -0,0 +1,105 @@ +# SOME DESCRIPTIVE TITLE. +# This file is put in the public domain. +# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-01 16:15-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" +"Language-Team: LANGUAGE <LL@li.org>\n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=CHARSET\n" +"Content-Transfer-Encoding: 8bit\n" + +#: gt_01.c:42 +#, c-format +msgid "{:bytes}{N:byte,bytes}\n" +msgstr "" + +#: gt_01.c:44 +#, c-format +msgid "{L:total} {:total}\n" +msgstr "" + +#: gt_01.c:60 +#, c-format +msgid "Only {:marzlevanes} {N:marzlevane,marzlevanes} are functioning correctly\n" +msgstr "" + +#: gt_01.c:63 +msgid "Version {:version} {:date}\n" +msgstr "" + +#: gt_01.c:66 +msgid "Unable to {:verb} forward velociping" +msgstr "" + +#: gt_01.c:67 +msgid "{:style} synchronization of {:type} {:target} failed" +msgstr "" + +#: gt_01.c:69 +#, c-format +msgid "{L:hydrocoptic marzlevanes}{:marzlevanes}\n" +msgstr "" + +#: gt_01.c:71 +msgid "{L:Windings}{:windings}\n" +msgstr "" + +msgid "byte" +msgid_plural "bytes" +msgstr[0] "" +msgstr[1] "" + +msgid "marzlevane" +msgid_plural "marzlevanes" +msgstr[0] "" +msgstr[1] "" + +msgid "lotus-o-delta" +msgstr "" + +msgid "cardinal" +msgstr "" + +msgid "automatic" +msgstr "" + +msgid "grammeters" +msgstr "" + +msgid "objectulate" +msgstr "" + +msgid "hydrocoptic marzlevanes" +msgstr "" + +msgid "Windings" +msgstr "" + +msgid "Your {:adjective} {:noun} is {:verb} {:owner} {:target}\n" +msgstr "" + +msgid "The {:adjective} {:noun} was {:verb} {:owner} {:target}\n" +msgstr "" + +msgid "flaming" +msgstr "" + +msgid "sword" +msgstr "" + +msgid "burning" +msgstr "" + +msgid "my" +msgstr "" + +msgid "couch" +msgstr "" diff --git a/contrib/libxo/tests/gettext/ldns.pot b/contrib/libxo/tests/gettext/ldns.pot new file mode 100644 index 000000000000..6e3df201004a --- /dev/null +++ b/contrib/libxo/tests/gettext/ldns.pot @@ -0,0 +1,28 @@ +# SOME DESCRIPTIVE TITLE. +# This file is put in the public domain. +# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-01 16:15-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" +"Language-Team: LANGUAGE <LL@li.org>\n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=CHARSET\n" +"Content-Transfer-Encoding: 8bit\n" + +#: gt_01.c:46 +#, c-format +msgid "Received {:received} {N:byte,bytes} from {:from}#{:port} in {:time} ms\n" +msgstr "" + +msgid "byte" +msgid_plural "bytes" +msgstr[0] "" +msgstr[1] "" + diff --git a/contrib/libxo/tests/gettext/po/pig_latin/gt_01.po b/contrib/libxo/tests/gettext/po/pig_latin/gt_01.po new file mode 100644 index 000000000000..269bad54b2a4 --- /dev/null +++ b/contrib/libxo/tests/gettext/po/pig_latin/gt_01.po @@ -0,0 +1,109 @@ +# SOME DESCRIPTIVE TITLE. +# This file is put in the public domain. +# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: libxo unit test\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-01 16:15-0400\n" +"PO-Revision-Date: 2015-07-09 13:43-0400\n" +"Last-Translator: P.S. <ps@example.com>\n" +"Language-Team: Self-inflicted <test@example.com>\n" +"Language: teo\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Poedit 1.8.1\n" +"Plural-Forms: nplurals=3; plural=(n==0) ? 0 : (n==1) ? 1 : 2;\n" +"X-Poedit-SourceCharset: iso-8859-1\n" + +#: gt_01.c:42 +#, c-format +msgid "{:bytes}{N:byte,bytes}\n" +msgstr "{:bytes}{N:ytebay,ytesbay}\n" + +#: gt_01.c:44 +#, c-format +msgid "{L:total} {:total}\n" +msgstr "{L:otaltay} {:total}\n" + +#: gt_01.c:60 +#, c-format +msgid "Only {:marzlevanes} {N:marzlevane,marzlevanes} are functioning correctly\n" +msgstr "Onlyay {:marzlevanes} {N:marzlevane,marzlevanes} areyay unctioningfay orrectlycay\n" + +#: gt_01.c:63 +msgid "Version {:version} {:date}\n" +msgstr "Ersionvay {:date} {:version}\n" + +#: gt_01.c:66 +msgid "Unable to {:verb} forward velociping" +msgstr "Nableuay otay {:verb} orwardfay elocipingvay" + +#: gt_01.c:67 +msgid "{:style} synchronization of {:type} {:target} failed" +msgstr "{:style} ynchronizationsay ofyay {:type} {:target} ailedfay" + +#: gt_01.c:69 +#, c-format +msgid "{L:hydrocoptic marzlevanes}{:marzlevanes}\n" +msgstr "{L:ydrocoptichay arzlevanesmay}{:marzlevanes}\n" + +#: gt_01.c:71 +msgid "{L:Windings}{:windings}\n" +msgstr "Dude, {L:Windings}{:windings}\n" + +msgid "byte" +msgid_plural "bytes" +msgstr[0] "yebay" +msgstr[1] "yesbay" +msgstr[2] "yezbay" + +msgid "marzlevane" +msgid_plural "marzlevanes" +msgstr[0] "arzlevanemay" +msgstr[1] "arzlevanesmay" +msgstr[2] "arzlevanezmay" + +msgid "lotus-o-delta" +msgstr "otuslay-oyay-eltayay" + +msgid "cardinal" +msgstr "ardinalyay" + +msgid "automatic" +msgstr "automaticyay" + +msgid "grammeters" +msgstr "ammetersgray" + +msgid "objectulate" +msgstr "ectulatobjay" + +msgid "hydrocoptic marzlevanes" +msgstr "ydrocoptichay arzlevanesmay" + +msgid "Windings" +msgstr "Indingsway" + +msgid "Your {:adjective} {:noun} is {:verb} {:owner} {:target}\n" +msgstr "Ouryay {:noun} {:adjective} isyay {:owner}{:target} bubbly-bubbly {:verb}\n" + +msgid "The {:adjective} {:noun} was {:verb} {:owner} {:target}\n" +msgstr "Ethay {:noun} asway '{:owner}{:adjective}{:target}' {:verb}\n" + +msgid "flaming" +msgstr "amingflay" + +msgid "sword" +msgstr "ordsway" + +msgid "burning" +msgstr "urningbay" + +msgid "my" +msgstr "ymay" + +msgid "couch" +msgstr "ouchcay" diff --git a/contrib/libxo/tests/gettext/po/pig_latin/ldns.po b/contrib/libxo/tests/gettext/po/pig_latin/ldns.po new file mode 100644 index 000000000000..83d5aeee6ccf --- /dev/null +++ b/contrib/libxo/tests/gettext/po/pig_latin/ldns.po @@ -0,0 +1,30 @@ +# SOME DESCRIPTIVE TITLE. +# This file is put in the public domain. +# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: libxo unit test\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-01 16:15-0400\n" +"PO-Revision-Date: 2015-07-01 18:47-0500\n" +"Last-Translator: P.S. <ps@example.com>\n" +"Language-Team: Self-inflicted <test@example.com>\n" +"Language: teo\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"X-Generator: Poedit 1.8.1\n" +"Plural-Forms: nplurals=3; plural=(n==0) ? 0 : (n==1) ? 1 : 2;\n" +"X-Poedit-SourceCharset: iso-8859-1\n" + +#: gt_01.c:46 +#, c-format +msgid "Received {:received} {N:byte,bytes} from {:from}#{:port} in {:time} ms\n" +msgstr "Eceivedray {:received} {N:byte,bytes} omfray {:from}#{:port} inyay {:time} msyay\n" + +msgid "byte" +msgid_plural "bytes" +msgstr[0] "ldb0" +msgstr[1] "ldb1" +msgstr[2] "ldb2" diff --git a/contrib/libxo/tests/gettext/po/pig_latin/strerror.po b/contrib/libxo/tests/gettext/po/pig_latin/strerror.po new file mode 100644 index 000000000000..cffae6512c22 --- /dev/null +++ b/contrib/libxo/tests/gettext/po/pig_latin/strerror.po @@ -0,0 +1,463 @@ +# +# Copyright (c) 1982, 1985, 1993 +# The Regents of the University of California. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. Neither the name of the University nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# List of system errors ala strerror() and sys_errlist +# Phil Shafer <phil@juniper.net>, 2015. +# +msgid "" +msgstr "" +"Project-Id-Version: libxo test\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-01 16:15-0400\n" +"PO-Revision-Date: 2015-07-02 00:37-0500\n" +"Language: teo\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=3; plural=(n==0) ? 0 : (n==1) ? 1 : 2;\n" +"Last-Translator: P.S. <ps@example.com>\n" +"Language-Team: self inflicted <test@example.com>\n" +"X-Generator: Poedit 1.8.1\n" +"X-Poedit-SourceCharset: iso-8859-1\n" + +# 0 - ENOERROR +msgid "No error: 0" +msgstr "Onyay erroryay" + +# 1 - EPERM +msgid "Operation not permitted" +msgstr "Operationyay otnay ermittedpay" + +# 2 - ENOENT +msgid "No such file or directory" +msgstr "Onay uchsay ilefay oryay irectoryday" + +# 3 - ESRCH +msgid "No such process" +msgstr "Onay uchsay ocesspray" + +# 4 - EINTR +msgid "Interrupted system call" +msgstr "Interruptedyay ystemsay allcay" + +# 5 - EIO +msgid "Input/output error" +msgstr "Input/outputyay erroryay" + +# 6 - ENXIO +msgid "Device not configured" +msgstr "Eviceday otnay onfiguredcay" + +# 7 - E2BIG +msgid "Argument list too long" +msgstr "Argumentyay istlay ootay onglay" + +# 8 - ENOEXEC +msgid "Exec format error" +msgstr "Execway ormatfay errorway" + +# 9 - EBADF +msgid "Bad file descriptor" +msgstr "Adbay ilefay escriptorday" + +# 10 - ECHILD +msgid "No child processes" +msgstr "Onay ildchay ocessespray" + +# 11 - EDEADLK +msgid "Resource deadlock avoided" +msgstr "Esourceray eadlockday avoidedway" + +# 12 - ENOMEM +msgid "Cannot allocate memory" +msgstr "Annotcay allocateway emorymay" + +# 13 - EACCES +msgid "Permission denied" +msgstr "Ermissionpay eniedday" + +# 14 - EFAULT +msgid "Bad address" +msgstr "Adbay addressway" + +# 15 - ENOTBLK +msgid "Block device required" +msgstr "Ockblay eviceday equiredray" + +# 16 - EBUSY +msgid "Device busy" +msgstr "Eviceday usybay" + +# 17 - EEXIST +msgid "File exists" +msgstr "Ilefay existsway" + +# 18 - EXDEV +msgid "Cross-device link" +msgstr "Osscray-eviceday inklay" + +# 19 - ENODEV +msgid "Operation not supported by device" +msgstr "Operationway otnay upportedsay ybay eviceday" + +# 20 - ENOTDIR +msgid "Not a directory" +msgstr "Otnay away irectoryday" + +# 21 - EISDIR +msgid "Is a directory" +msgstr "Isway away irectoryday" + +# 22 - EINVAL +msgid "Invalid argument" +msgstr "Invalidway argumentway" + +# 23 - ENFILE +msgid "Too many open files in system" +msgstr "Ootay anymay openway ilesfay inway ystemsay" + +# 24 - EMFILE +msgid "Too many open files" +msgstr "Ootay anymay openway ilesfay" + +# 25 - ENOTTY +msgid "Inappropriate ioctl for device" +msgstr "Inappropriateway ioctlway orfay eviceday" + +# 26 - ETXTBSY +msgid "Text file busy" +msgstr "Exttay ilefay usybay" + +# 27 - EFBIG +msgid "File too large" +msgstr "Ilefay ootay argelay" + +# 28 - ENOSPC +msgid "No space left on device" +msgstr "Onay acespay eftlay onway eviceday" + +# 29 - ESPIPE +msgid "Illegal seek" +msgstr "Illegalway eeksay" + +# 30 - EROFS +msgid "Read-only file system" +msgstr "Eadray-onlyway ilefay ystemsay" + +# 31 - EMLINK +msgid "Too many links" +msgstr "Ootay anymay inkslay" + +# 32 - EPIPE +msgid "Broken pipe" +msgstr "Okenbray ipepay" + +# +# math software +# +# 33 - EDOM +msgid "Numerical argument out of domain" +msgstr "Umericalnay argumentway outway ofway omainday" + +# 34 - ERANGE +msgid "Result too large" +msgstr "Esultray ootay argelay" + +# +# non-blocking and interrupt i/o +# +# 35 - EAGAIN +# 35 - EWOULDBLOCK +msgid "Resource temporarily unavailable" +msgstr "Esourceray emporarilytay unavailableway" + +# 36 - EINPROGRESS +msgid "Operation now in progress" +msgstr "Operationway ownay inway ogresspray" + +# 37 - EALREADY +msgid "Operation already in progress" +msgstr "Operationway alreadyway inway ogresspray" + +# +# ipc/network software -- argument errors +# +# 38 - ENOTSOCK +msgid "Socket operation on non-socket" +msgstr "Ocketsay operationway onway onnay-ocketsay" + +# 39 - EDESTADDRREQ +msgid "Destination address required" +msgstr "Estinationday addressway equiredray" + +# 40 - EMSGSIZE +msgid "Message too long" +msgstr "Essagemay ootay onglay" + +# 41 - EPROTOTYPE +msgid "Protocol wrong type for socket" +msgstr "Otocolpray ongwray ypetay orfay ocketsay" + +# 42 - ENOPROTOOPT +msgid "Protocol not available" +msgstr "Otocolpray otnay availableway" + +# 43 - EPROTONOSUPPORT +msgid "Protocol not supported" +msgstr "Otocolpray otnay upportedsay" + +# 44 - ESOCKTNOSUPPORT +msgid "Socket type not supported" +msgstr "Ocketsay ypetay otnay upportedsay" + +# 45 - EOPNOTSUPP +msgid "Operation not supported" +msgstr "Operationway otnay upportedsay" + +# 46 - EPFNOSUPPORT +msgid "Protocol family not supported" +msgstr "Otocolpray amilyfay otnay upportedsay" + +# 47 - EAFNOSUPPORT +msgid "Address family not supported by protocol family" +msgstr "Addressway amilyfay otnay upportedsay ybay otocolpray amilyfay" + +# 48 - EADDRINUSE +msgid "Address already in use" +msgstr "Addressway alreadyway inway useway" + +# 49 - EADDRNOTAVAIL +msgid "Can't assign requested address" +msgstr "An'tcay assignway equestedray addressway" + +# +# ipc/network software -- operational errors +# +# 50 - ENETDOWN +msgid "Network is down" +msgstr "Etworknay isway ownday" + +# 51 - ENETUNREACH +msgid "Network is unreachable" +msgstr "Etworknay isway unreachableway" + +# 52 - ENETRESET +msgid "Network dropped connection on reset" +msgstr "Etworknay oppeddray onnectioncay onway esetray" + +# 53 - ECONNABORTED +msgid "Software caused connection abort" +msgstr "Oftwaresay ausedcay onnectioncay abortway" + +# 54 - ECONNRESET +msgid "Connection reset by peer" +msgstr "Onnectioncay esetray ybay eerpay" + +# 55 - ENOBUFS +msgid "No buffer space available" +msgstr "Onay ufferbay acespay availableway" + +# 56 - EISCONN +msgid "Socket is already connected" +msgstr "Ocketsay isway alreadyway onnectedcay" + +# 57 - ENOTCONN +msgid "Socket is not connected" +msgstr "Ocketsay isway otnay onnectedcay" + +# 58 - ESHUTDOWN +msgid "Can't send after socket shutdown" +msgstr "An'tcay endsay afterway ocketsay utdownshay" + +# 59 - ETOOMANYREFS +msgid "Too many references: can't splice" +msgstr "Ootay anymay eferencesray: an'tcay icesplay" + +# 60 - ETIMEDOUT +msgid "Operation timed out" +msgstr "Operationway imedtay outway" + +# 61 - ECONNREFUSED +msgid "Connection refused" +msgstr "Onnectioncay efusedray" + +# 62 - ELOOP +msgid "Too many levels of symbolic links" +msgstr "Ootay anymay evelslay ofway ymbolicsay inkslay" + +# 63 - ENAMETOOLONG +msgid "File name too long" +msgstr "Ilefay amenay ootay onglay" + +# +# should be rearranged +# +# 64 - EHOSTDOWN +msgid "Host is down" +msgstr "Osthay isway ownday" + +# 65 - EHOSTUNREACH +msgid "No route to host" +msgstr "Onay outeray otay osthay" + +# 66 - ENOTEMPTY +msgid "Directory not empty" +msgstr "Irectoryday otnay emptyway" + +# +# quotas & mush +# +# 67 - EPROCLIM +msgid "Too many processes" +msgstr "Ootay anymay ocessespray" + +# 68 - EUSERS +msgid "Too many users" +msgstr "Ootay anymay usersway" + +# 69 - EDQUOT +msgid "Disc quota exceeded" +msgstr "Iscday otaquay exceededway" + +# +# Network File System +# +# 70 - ESTALE +msgid "Stale NFS file handle" +msgstr "Alestay NFSAY ilefay andlehay" + +# 71 - EREMOTE +msgid "Too many levels of remote in path" +msgstr "Ootay anymay evelslay ofway emoteray inway athpay" + +# 72 - EBADRPC +msgid "RPC struct is bad" +msgstr "RPCAY uctstray isway adbay" + +# 73 - ERPCMISMATCH +msgid "RPC version wrong" +msgstr "RPCAY ersionvay ongwray" + +# 74 - EPROGUNAVAIL +msgid "RPC prog. not avail" +msgstr "RPCAY ogpray. otnay availway" + +# 75 - EPROGMISMATCH +msgid "Program version wrong" +msgstr "Ogrampray ersionvay ongwray" + +# 76 - EPROCUNAVAIL +msgid "Bad procedure for program" +msgstr "Adbay ocedurepray orfay ogrampray" + +# 77 - ENOLCK +msgid "No locks available" +msgstr "Onay ockslay availableway" + +# 78 - ENOSYS +msgid "Function not implemented" +msgstr "Unctionfay otnay implementedway" + +# 79 - EFTYPE +msgid "Inappropriate file type or format" +msgstr "Inappropriateway ilefay ypetay orway ormatfay" + +# 80 - EAUTH +msgid "Authentication error" +msgstr "Authenticationway errorway" + +# 81 - ENEEDAUTH +msgid "Need authenticator" +msgstr "Eednay authenticatorway" + +# 82 - EIDRM +msgid "Identifier removed" +msgstr "Identifierway emovedray" + +# 83 - ENOMSG +msgid "No message of desired type" +msgstr "Onay essagemay ofway esiredday ypetay" + +# 84 - EOVERFLOW +msgid "Value too large to be stored in data type" +msgstr "Aluevay ootay argelay otay ebay oredstay inway ataday ypetay" + +# 85 - ECANCELED +msgid "Operation canceled" +msgstr "Operationway anceledcay" + +# 86 - EILSEQ +msgid "Illegal byte sequence" +msgstr "Illegalway ytebay equencesay" + +# 87 - ENOATTR +msgid "Attribute not found" +msgstr "Attributeway otnay oundfay" + +# +# General +# +# 88 - EDOOFUS +msgid "Programming error" +msgstr "Ogrammingpray errorway" + +# 89 - EBADMSG +msgid "Bad message" +msgstr "Adbay essagemay" + +# 90 - EMULTIHOP +msgid "Multihop attempted" +msgstr "Ultihopmay attemptedway" + +# 91 - ENOLINK +msgid "Link has been severed" +msgstr "Inklay ashay eenbay everedsay" + +# 92 - EPROTO +msgid "Protocol error" +msgstr "Otocolpray errorway" + +# 93 - ENOTCAPABLE +msgid "Capabilities insufficient" +msgstr "Apabilitiescay insufficientway" + +# 94 - ECAPMODE +msgid "Not permitted in capability mode" +msgstr "Otnay ermittedpay inway apabilitycay odemay" + +# 95 - ENOTRECOVERABLE +msgid "State not recoverable" +msgstr "Atestay otnay ecoverableray" + +# 96 - EOWNERDEAD +msgid "Previous owner died" +msgstr "Eviouspray ownerway iedday" + +# 97 - EINTEGRITY +msgid "Integrity check failed" +msgstr "Integrityway eckchey ailedfey" diff --git a/contrib/libxo/tests/gettext/saved/gt_01.H.err b/contrib/libxo/tests/gettext/saved/gt_01.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.H.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.H.out b/contrib/libxo/tests/gettext/saved/gt_01.H.out new file mode 100644 index 000000000000..76122633673a --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.H.out @@ -0,0 +1 @@ +<div class="line"><div class="text">Ouryay </div><div class="data" data-tag="noun">ordsway</div><div class="text"> </div><div class="data" data-tag="adjective">amingflay</div><div class="text"> isyay </div><div class="data" data-tag="owner">ymay</div><div class="data" data-tag="target">ouchcay</div><div class="text"> bubbly-bubbly </div><div class="data" data-tag="verb">urningbay</div></div><div class="line"><div class="text">Ethay </div><div class="data" data-tag="noun">ordsway</div><div class="text"> asway '</div><div class="data" data-tag="owner">ymay</div><div class="data" data-tag="adjective">amingflay</div><div class="data" data-tag="target">ouchcay</div><div class="text">' </div><div class="data" data-tag="verb">urningbay</div></div><div class="line"><div class="data" data-tag="bytes">0</div><div class="padding"> </div><div class="note">yebay</div></div><div class="line"><div class="data" data-tag="bytes">1</div><div class="padding"> </div><div class="note">yesbay</div></div><div class="line"><div class="data" data-tag="bytes">2</div><div class="padding"> </div><div class="note">yezbay</div></div><div class="line"><div class="data" data-tag="bytes">3</div><div class="padding"> </div><div class="note">yezbay</div></div><div class="line"><div class="data" data-tag="bytes">4</div><div class="padding"> </div><div class="note">yezbay</div></div><div class="line"><div class="label">otaltay</div><div class="text"> </div><div class="data" data-tag="total">1234</div></div><div class="line"><div class="text">Eceivedray </div><div class="data" data-tag="received">1234</div><div class="text"> </div><div class="note">ldb2</div><div class="text"> omfray </div><div class="data" data-tag="from">foop</div><div class="text">#</div><div class="data" data-tag="port">4321</div><div class="text"> inyay </div><div class="data" data-tag="time">32</div><div class="text"> msyay</div></div><div class="line"><div class="text">Received </div><div class="data" data-tag="received">1234</div><div class="text"> </div><div class="note">yezbay</div><div class="text"> from </div><div class="data" data-tag="from">foop</div><div class="text">#</div><div class="data" data-tag="port">4321</div><div class="text"> in </div><div class="data" data-tag="time">32</div><div class="text"> ms</div></div><div class="line"><div class="text">Eceivedray </div><div class="data" data-tag="received">1234</div><div class="text"> </div><div class="note">ldb2</div><div class="text"> omfray </div><div class="data" data-tag="from">foop</div><div class="text">#</div><div class="data" data-tag="port">4321</div><div class="text"> inyay </div><div class="data" data-tag="time">32</div><div class="text"> msyay</div></div><div class="line"><div class="text">Onlyay </div><div class="data" data-tag="marzlevanes">3</div><div class="text"> </div><div class="note">arzlevanezmay</div><div class="text"> areyay unctioningfay orrectlycay</div></div><div class="line"><div class="text">Ersionvay </div><div class="data" data-tag="date">Tue Jun 23 18:47:09 UTC 2015</div><div class="text"> </div><div class="data" data-tag="version">1.2.3</div></div><div class="line"><div class="data" data-tag="program">gt_01</div><div class="decoration">:</div><div class="padding"> </div><div class="text">Nableuay otay </div><div class="data" data-tag="verb">ectulatobjay</div><div class="text"> orwardfay elocipingvay</div><div class="text">: </div><div class="data" data-tag="error">Ermissionpay eniedday</div></div><div class="line"><div class="data" data-tag="program">gt_01</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="style">automaticyay</div><div class="text"> ynchronizationsay ofyay </div><div class="data" data-tag="type">ardinalyay</div><div class="text"> </div><div class="data" data-tag="target">ammetersgray</div><div class="text"> ailedfay</div><div class="text">: </div><div class="data" data-tag="error">Ermissionpay eniedday</div></div><div class="line"><div class="label">ydrocoptichay arzlevanesmay</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="marzlevanes">6</div></div><div class="line"><div class="text">Dude, </div><div class="label">Indingsway</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="windings">otuslay-oyay-eltayay</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/gettext/saved/gt_01.HIPx.err b/contrib/libxo/tests/gettext/saved/gt_01.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.HIPx.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.HIPx.out b/contrib/libxo/tests/gettext/saved/gt_01.HIPx.out new file mode 100644 index 000000000000..597bd1e7f8ab --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.HIPx.out @@ -0,0 +1,139 @@ +<div class="line"> + <div class="text">Ouryay </div> + <div class="data" data-tag="noun" data-xpath="/top/noun">ordsway</div> + <div class="text"> </div> + <div class="data" data-tag="adjective" data-xpath="/top/adjective">amingflay</div> + <div class="text"> isyay </div> + <div class="data" data-tag="owner" data-xpath="/top/owner">ymay</div> + <div class="data" data-tag="target" data-xpath="/top/target">ouchcay</div> + <div class="text"> bubbly-bubbly </div> + <div class="data" data-tag="verb" data-xpath="/top/verb">urningbay</div> +</div> +<div class="line"> + <div class="text">Ethay </div> + <div class="data" data-tag="noun" data-xpath="/top/noun">ordsway</div> + <div class="text"> asway '</div> + <div class="data" data-tag="owner" data-xpath="/top/owner">ymay</div> + <div class="data" data-tag="adjective" data-xpath="/top/adjective">amingflay</div> + <div class="data" data-tag="target" data-xpath="/top/target">ouchcay</div> + <div class="text">' </div> + <div class="data" data-tag="verb" data-xpath="/top/verb">urningbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/bytes">0</div> + <div class="padding"> </div> + <div class="note">yebay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/bytes">1</div> + <div class="padding"> </div> + <div class="note">yesbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/bytes">2</div> + <div class="padding"> </div> + <div class="note">yezbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/bytes">3</div> + <div class="padding"> </div> + <div class="note">yezbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes" data-xpath="/top/bytes">4</div> + <div class="padding"> </div> + <div class="note">yezbay</div> +</div> +<div class="line"> + <div class="label">otaltay</div> + <div class="text"> </div> + <div class="data" data-tag="total" data-xpath="/top/total">1234</div> +</div> +<div class="line"> + <div class="text">Eceivedray </div> + <div class="data" data-tag="received" data-xpath="/top/received">1234</div> + <div class="text"> </div> + <div class="note">ldb2</div> + <div class="text"> omfray </div> + <div class="data" data-tag="from" data-xpath="/top/from">foop</div> + <div class="text">#</div> + <div class="data" data-tag="port" data-xpath="/top/port">4321</div> + <div class="text"> inyay </div> + <div class="data" data-tag="time" data-xpath="/top/time">32</div> + <div class="text"> msyay</div> +</div> +<div class="line"> + <div class="text">Received </div> + <div class="data" data-tag="received" data-xpath="/top/received">1234</div> + <div class="text"> </div> + <div class="note">yezbay</div> + <div class="text"> from </div> + <div class="data" data-tag="from" data-xpath="/top/from">foop</div> + <div class="text">#</div> + <div class="data" data-tag="port" data-xpath="/top/port">4321</div> + <div class="text"> in </div> + <div class="data" data-tag="time" data-xpath="/top/time">32</div> + <div class="text"> ms</div> +</div> +<div class="line"> + <div class="text">Eceivedray </div> + <div class="data" data-tag="received" data-xpath="/top/received">1234</div> + <div class="text"> </div> + <div class="note">ldb2</div> + <div class="text"> omfray </div> + <div class="data" data-tag="from" data-xpath="/top/from">foop</div> + <div class="text">#</div> + <div class="data" data-tag="port" data-xpath="/top/port">4321</div> + <div class="text"> inyay </div> + <div class="data" data-tag="time" data-xpath="/top/time">32</div> + <div class="text"> msyay</div> +</div> +<div class="line"> + <div class="text">Onlyay </div> + <div class="data" data-tag="marzlevanes" data-xpath="/top/marzlevanes">3</div> + <div class="text"> </div> + <div class="note">arzlevanezmay</div> + <div class="text"> areyay unctioningfay orrectlycay</div> +</div> +<div class="line"> + <div class="text">Ersionvay </div> + <div class="data" data-tag="date" data-xpath="/top/date">Tue Jun 23 18:47:09 UTC 2015</div> + <div class="text"> </div> + <div class="data" data-tag="version" data-xpath="/top/version">1.2.3</div> +</div> +<div class="line"> + <div class="data" data-tag="program" data-xpath="/top/xo_emit_warn_hcv/__warning/program">gt_01</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="text">Nableuay otay </div> + <div class="data" data-tag="verb" data-xpath="/top/xo_emit_warn_hcv/__warning/verb">ectulatobjay</div> + <div class="text"> orwardfay elocipingvay</div> + <div class="text">: </div> + <div class="data" data-tag="error" data-xpath="/top/xo_emit_warn_hcv/__warning/error">Ermissionpay eniedday</div> +</div> +<div class="line"> + <div class="data" data-tag="program" data-xpath="/top/xo_emit_warn_hcv/__warning/program">gt_01</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="style" data-xpath="/top/xo_emit_warn_hcv/__warning/style">automaticyay</div> + <div class="text"> ynchronizationsay ofyay </div> + <div class="data" data-tag="type" data-xpath="/top/xo_emit_warn_hcv/__warning/type">ardinalyay</div> + <div class="text"> </div> + <div class="data" data-tag="target" data-xpath="/top/xo_emit_warn_hcv/__warning/target">ammetersgray</div> + <div class="text"> ailedfay</div> + <div class="text">: </div> + <div class="data" data-tag="error" data-xpath="/top/xo_emit_warn_hcv/__warning/error">Ermissionpay eniedday</div> +</div> +<div class="line"> + <div class="label">ydrocoptichay arzlevanesmay</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="marzlevanes" data-xpath="/top/marzlevanes">6</div> +</div> +<div class="line"> + <div class="text">Dude, </div> + <div class="label">Indingsway</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="windings" data-xpath="/top/windings">otuslay-oyay-eltayay</div> +</div> diff --git a/contrib/libxo/tests/gettext/saved/gt_01.HP.err b/contrib/libxo/tests/gettext/saved/gt_01.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.HP.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.HP.out b/contrib/libxo/tests/gettext/saved/gt_01.HP.out new file mode 100644 index 000000000000..de711f00b59e --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.HP.out @@ -0,0 +1,139 @@ +<div class="line"> + <div class="text">Ouryay </div> + <div class="data" data-tag="noun">ordsway</div> + <div class="text"> </div> + <div class="data" data-tag="adjective">amingflay</div> + <div class="text"> isyay </div> + <div class="data" data-tag="owner">ymay</div> + <div class="data" data-tag="target">ouchcay</div> + <div class="text"> bubbly-bubbly </div> + <div class="data" data-tag="verb">urningbay</div> +</div> +<div class="line"> + <div class="text">Ethay </div> + <div class="data" data-tag="noun">ordsway</div> + <div class="text"> asway '</div> + <div class="data" data-tag="owner">ymay</div> + <div class="data" data-tag="adjective">amingflay</div> + <div class="data" data-tag="target">ouchcay</div> + <div class="text">' </div> + <div class="data" data-tag="verb">urningbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">0</div> + <div class="padding"> </div> + <div class="note">yebay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">1</div> + <div class="padding"> </div> + <div class="note">yesbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">2</div> + <div class="padding"> </div> + <div class="note">yezbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">3</div> + <div class="padding"> </div> + <div class="note">yezbay</div> +</div> +<div class="line"> + <div class="data" data-tag="bytes">4</div> + <div class="padding"> </div> + <div class="note">yezbay</div> +</div> +<div class="line"> + <div class="label">otaltay</div> + <div class="text"> </div> + <div class="data" data-tag="total">1234</div> +</div> +<div class="line"> + <div class="text">Eceivedray </div> + <div class="data" data-tag="received">1234</div> + <div class="text"> </div> + <div class="note">ldb2</div> + <div class="text"> omfray </div> + <div class="data" data-tag="from">foop</div> + <div class="text">#</div> + <div class="data" data-tag="port">4321</div> + <div class="text"> inyay </div> + <div class="data" data-tag="time">32</div> + <div class="text"> msyay</div> +</div> +<div class="line"> + <div class="text">Received </div> + <div class="data" data-tag="received">1234</div> + <div class="text"> </div> + <div class="note">yezbay</div> + <div class="text"> from </div> + <div class="data" data-tag="from">foop</div> + <div class="text">#</div> + <div class="data" data-tag="port">4321</div> + <div class="text"> in </div> + <div class="data" data-tag="time">32</div> + <div class="text"> ms</div> +</div> +<div class="line"> + <div class="text">Eceivedray </div> + <div class="data" data-tag="received">1234</div> + <div class="text"> </div> + <div class="note">ldb2</div> + <div class="text"> omfray </div> + <div class="data" data-tag="from">foop</div> + <div class="text">#</div> + <div class="data" data-tag="port">4321</div> + <div class="text"> inyay </div> + <div class="data" data-tag="time">32</div> + <div class="text"> msyay</div> +</div> +<div class="line"> + <div class="text">Onlyay </div> + <div class="data" data-tag="marzlevanes">3</div> + <div class="text"> </div> + <div class="note">arzlevanezmay</div> + <div class="text"> areyay unctioningfay orrectlycay</div> +</div> +<div class="line"> + <div class="text">Ersionvay </div> + <div class="data" data-tag="date">Tue Jun 23 18:47:09 UTC 2015</div> + <div class="text"> </div> + <div class="data" data-tag="version">1.2.3</div> +</div> +<div class="line"> + <div class="data" data-tag="program">gt_01</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="text">Nableuay otay </div> + <div class="data" data-tag="verb">ectulatobjay</div> + <div class="text"> orwardfay elocipingvay</div> + <div class="text">: </div> + <div class="data" data-tag="error">Ermissionpay eniedday</div> +</div> +<div class="line"> + <div class="data" data-tag="program">gt_01</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="style">automaticyay</div> + <div class="text"> ynchronizationsay ofyay </div> + <div class="data" data-tag="type">ardinalyay</div> + <div class="text"> </div> + <div class="data" data-tag="target">ammetersgray</div> + <div class="text"> ailedfay</div> + <div class="text">: </div> + <div class="data" data-tag="error">Ermissionpay eniedday</div> +</div> +<div class="line"> + <div class="label">ydrocoptichay arzlevanesmay</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="marzlevanes">6</div> +</div> +<div class="line"> + <div class="text">Dude, </div> + <div class="label">Indingsway</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="windings">otuslay-oyay-eltayay</div> +</div> diff --git a/contrib/libxo/tests/gettext/saved/gt_01.J.err b/contrib/libxo/tests/gettext/saved/gt_01.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.J.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.J.out b/contrib/libxo/tests/gettext/saved/gt_01.J.out new file mode 100644 index 000000000000..5a258a8b4cb0 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.J.out @@ -0,0 +1 @@ +{"top": {"adjective":"amingflay","noun":"ordsway","verb":"urningbay","owner":"ymay","target":"ouchcay","adjective":"amingflay","noun":"ordsway","verb":"urningbay","owner":"ymay","target":"ouchcay", "bytes": [0,1,2,3,4],"total":1234,"received":1234,"from":"foop","port":4321,"time":32,"received":1234,"from":"foop","port":4321,"time":32,"received":1234,"from":"foop","port":4321,"time":32,"marzlevanes":3,"version":"1.2.3","date":"Tue Jun 23 18:47:09 UTC 2015", "__warning": {"program":"gt_01","message":"Nableuay otay ectulatobjay orwardfay elocipingvay","verb":"ectulatobjay","error":"Ermissionpay eniedday"}, "__warning": {"program":"gt_01","message":"automaticyay ynchronizationsay ofyay ardinalyay ammetersgray ailedfay","style":"automaticyay","type":"ardinalyay","target":"ammetersgray","error":"Ermissionpay eniedday"},"marzlevanes":6,"windings":"otuslay-oyay-eltayay"}} diff --git a/contrib/libxo/tests/gettext/saved/gt_01.JP.err b/contrib/libxo/tests/gettext/saved/gt_01.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.JP.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.JP.out b/contrib/libxo/tests/gettext/saved/gt_01.JP.out new file mode 100644 index 000000000000..0717af5b4a67 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.JP.out @@ -0,0 +1,53 @@ +{ + "top": { + "adjective": "amingflay", + "noun": "ordsway", + "verb": "urningbay", + "owner": "ymay", + "target": "ouchcay", + "adjective": "amingflay", + "noun": "ordsway", + "verb": "urningbay", + "owner": "ymay", + "target": "ouchcay", + "bytes": [ + 0, + 1, + 2, + 3, + 4 + ], + "total": 1234, + "received": 1234, + "from": "foop", + "port": 4321, + "time": 32, + "received": 1234, + "from": "foop", + "port": 4321, + "time": 32, + "received": 1234, + "from": "foop", + "port": 4321, + "time": 32, + "marzlevanes": 3, + "version": "1.2.3", + "date": "Tue Jun 23 18:47:09 UTC 2015", + "__warning": { + "program": "gt_01", + "message": "Nableuay otay ectulatobjay orwardfay elocipingvay", + "verb": "ectulatobjay", + "error": "Ermissionpay eniedday" + }, + "__warning": { + "program": "gt_01", + "message": "automaticyay ynchronizationsay ofyay ardinalyay ammetersgray ailedfay", + "style": "automaticyay", + "type": "ardinalyay", + "target": "ammetersgray", + "error": "Ermissionpay eniedday" + }, + "marzlevanes": 6, + "windings": "otuslay-oyay-eltayay" + } +} diff --git a/contrib/libxo/tests/gettext/saved/gt_01.T.err b/contrib/libxo/tests/gettext/saved/gt_01.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.T.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.T.out b/contrib/libxo/tests/gettext/saved/gt_01.T.out new file mode 100644 index 000000000000..c8d9763616ce --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.T.out @@ -0,0 +1,17 @@ +Ouryay ordsway amingflay isyay ymayouchcay bubbly-bubbly urningbay +Ethay ordsway asway 'ymayamingflayouchcay' urningbay +0 yebay +1 yesbay +2 yezbay +3 yezbay +4 yezbay +otaltay 1234 +Eceivedray 1234 ldb2 omfray foop#4321 inyay 32 msyay +Received 1234 yezbay from foop#4321 in 32 ms +Eceivedray 1234 ldb2 omfray foop#4321 inyay 32 msyay +Onlyay 3 arzlevanezmay areyay unctioningfay orrectlycay +Ersionvay Tue Jun 23 18:47:09 UTC 2015 1.2.3 +gt_01: Nableuay otay ectulatobjay orwardfay elocipingvay: Ermissionpay eniedday +gt_01: automaticyay ynchronizationsay ofyay ardinalyay ammetersgray ailedfay: Ermissionpay eniedday +ydrocoptichay arzlevanesmay: 6 +Dude, Indingsway: otuslay-oyay-eltayay diff --git a/contrib/libxo/tests/gettext/saved/gt_01.X.err b/contrib/libxo/tests/gettext/saved/gt_01.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.X.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.X.out b/contrib/libxo/tests/gettext/saved/gt_01.X.out new file mode 100644 index 000000000000..803aca9f8572 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.X.out @@ -0,0 +1 @@ +<top><adjective>amingflay</adjective><noun>ordsway</noun><verb>urningbay</verb><owner>ymay</owner><target>ouchcay</target><adjective>amingflay</adjective><noun>ordsway</noun><verb>urningbay</verb><owner>ymay</owner><target>ouchcay</target><bytes>0</bytes><bytes>1</bytes><bytes>2</bytes><bytes>3</bytes><bytes>4</bytes><total>1234</total><received>1234</received><from>foop</from><port>4321</port><time>32</time><received>1234</received><from>foop</from><port>4321</port><time>32</time><received>1234</received><from>foop</from><port>4321</port><time>32</time><marzlevanes>3</marzlevanes><version>1.2.3</version><date>Tue Jun 23 18:47:09 UTC 2015</date><__warning><program>gt_01</program><message>Nableuay otay ectulatobjay orwardfay elocipingvay</message><verb>ectulatobjay</verb><error>Ermissionpay eniedday</error></__warning><__warning><program>gt_01</program><message>automaticyay ynchronizationsay ofyay ardinalyay ammetersgray ailedfay</message><style>automaticyay</style><type>ardinalyay</type><target>ammetersgray</target><error>Ermissionpay eniedday</error></__warning><marzlevanes>6</marzlevanes><windings>otuslay-oyay-eltayay</windings></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/gettext/saved/gt_01.XP.err b/contrib/libxo/tests/gettext/saved/gt_01.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.XP.err diff --git a/contrib/libxo/tests/gettext/saved/gt_01.XP.out b/contrib/libxo/tests/gettext/saved/gt_01.XP.out new file mode 100644 index 000000000000..456536db7744 --- /dev/null +++ b/contrib/libxo/tests/gettext/saved/gt_01.XP.out @@ -0,0 +1,49 @@ +<top> + <adjective>amingflay</adjective> + <noun>ordsway</noun> + <verb>urningbay</verb> + <owner>ymay</owner> + <target>ouchcay</target> + <adjective>amingflay</adjective> + <noun>ordsway</noun> + <verb>urningbay</verb> + <owner>ymay</owner> + <target>ouchcay</target> + <bytes>0</bytes> + <bytes>1</bytes> + <bytes>2</bytes> + <bytes>3</bytes> + <bytes>4</bytes> + <total>1234</total> + <received>1234</received> + <from>foop</from> + <port>4321</port> + <time>32</time> + <received>1234</received> + <from>foop</from> + <port>4321</port> + <time>32</time> + <received>1234</received> + <from>foop</from> + <port>4321</port> + <time>32</time> + <marzlevanes>3</marzlevanes> + <version>1.2.3</version> + <date>Tue Jun 23 18:47:09 UTC 2015</date> + <__warning> + <program>gt_01</program> + <message>Nableuay otay ectulatobjay orwardfay elocipingvay</message> + <verb>ectulatobjay</verb> + <error>Ermissionpay eniedday</error> + </__warning> + <__warning> + <program>gt_01</program> + <message>automaticyay ynchronizationsay ofyay ardinalyay ammetersgray ailedfay</message> + <style>automaticyay</style> + <type>ardinalyay</type> + <target>ammetersgray</target> + <error>Ermissionpay eniedday</error> + </__warning> + <marzlevanes>6</marzlevanes> + <windings>otuslay-oyay-eltayay</windings> +</top> diff --git a/contrib/libxo/tests/gettext/strerror.pot b/contrib/libxo/tests/gettext/strerror.pot new file mode 100644 index 000000000000..63da80d14325 --- /dev/null +++ b/contrib/libxo/tests/gettext/strerror.pot @@ -0,0 +1,472 @@ +# +# Copyright (c) 1982, 1985, 1993 +# The Regents of the University of California. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. Neither the name of the University nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# List of system errors ala strerror() and sys_errlist +# Phil Shafer <phil@juniper.net>, 2015. +# +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-01 16:15-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" +"Language-Team: LANGUAGE <LL@li.org>\n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=CHARSET\n" +"Content-Transfer-Encoding: 8bit\n" + +msgid "Received {:received} {N:byte,bytes} from {:from}#{:port} in {:time} ms\n" +msgstr "" + +# 0 - ENOERROR +msgid "No error: 0" +msgstr "" + +# 1 - EPERM +msgid "Operation not permitted" +msgstr "" + +# 2 - ENOENT +msgid "No such file or directory" +msgstr "" + +# 3 - ESRCH +msgid "No such process" +msgstr "" + +# 4 - EINTR +msgid "Interrupted system call" +msgstr "" + +# 5 - EIO +msgid "Input/output error" +msgstr "" + +# 6 - ENXIO +msgid "Device not configured" +msgstr "" + +# 7 - E2BIG +msgid "Argument list too long" +msgstr "" + +# 8 - ENOEXEC +msgid "Exec format error" +msgstr "" + +# 9 - EBADF +msgid "Bad file descriptor" +msgstr "" + +# 10 - ECHILD +msgid "No child processes" +msgstr "" + +# 11 - EDEADLK +msgid "Resource deadlock avoided" +msgstr "" + +# 12 - ENOMEM +msgid "Cannot allocate memory" +msgstr "" + +# 13 - EACCES +msgid "Permission denied" +msgstr "" + +# 14 - EFAULT +msgid "Bad address" +msgstr "" + +# 15 - ENOTBLK +msgid "Block device required" +msgstr "" + +# 16 - EBUSY +msgid "Device busy" +msgstr "" + +# 17 - EEXIST +msgid "File exists" +msgstr "" + +# 18 - EXDEV +msgid "Cross-device link" +msgstr "" + +# 19 - ENODEV +msgid "Operation not supported by device" +msgstr "" + +# 20 - ENOTDIR +msgid "Not a directory" +msgstr "" + +# 21 - EISDIR +msgid "Is a directory" +msgstr "" + +# 22 - EINVAL +msgid "Invalid argument" +msgstr "" + +# 23 - ENFILE +msgid "Too many open files in system" +msgstr "" + +# 24 - EMFILE +msgid "Too many open files" +msgstr "" + +# 25 - ENOTTY +msgid "Inappropriate ioctl for device" +msgstr "" + +# 26 - ETXTBSY +msgid "Text file busy" +msgstr "" + +# 27 - EFBIG +msgid "File too large" +msgstr "" + +# 28 - ENOSPC +msgid "No space left on device" +msgstr "" + +# 29 - ESPIPE +msgid "Illegal seek" +msgstr "" + +# 30 - EROFS +msgid "Read-only file system" +msgstr "" + +# 31 - EMLINK +msgid "Too many links" +msgstr "" + +# 32 - EPIPE +msgid "Broken pipe" +msgstr "" + +# +# math software +# + +# 33 - EDOM +msgid "Numerical argument out of domain" +msgstr "" + +# 34 - ERANGE +msgid "Result too large" +msgstr "" + +# +# non-blocking and interrupt i/o +# + +# 35 - EAGAIN +# 35 - EWOULDBLOCK +msgid "Resource temporarily unavailable" +msgstr "" + +# 36 - EINPROGRESS +msgid "Operation now in progress" +msgstr "" + +# 37 - EALREADY +msgid "Operation already in progress" +msgstr "" + + +# +# ipc/network software -- argument errors +# + +# 38 - ENOTSOCK +msgid "Socket operation on non-socket" +msgstr "" + +# 39 - EDESTADDRREQ +msgid "Destination address required" +msgstr "" + +# 40 - EMSGSIZE +msgid "Message too long" +msgstr "" + +# 41 - EPROTOTYPE +msgid "Protocol wrong type for socket" +msgstr "" + +# 42 - ENOPROTOOPT +msgid "Protocol not available" +msgstr "" + +# 43 - EPROTONOSUPPORT +msgid "Protocol not supported" +msgstr "" + +# 44 - ESOCKTNOSUPPORT +msgid "Socket type not supported" +msgstr "" + +# 45 - EOPNOTSUPP +msgid "Operation not supported" +msgstr "" + +# 46 - EPFNOSUPPORT +msgid "Protocol family not supported" +msgstr "" + +# 47 - EAFNOSUPPORT +msgid "Address family not supported by protocol family" +msgstr "" + +# 48 - EADDRINUSE +msgid "Address already in use" +msgstr "" + +# 49 - EADDRNOTAVAIL +msgid "Can't assign requested address" +msgstr "" + +# +# ipc/network software -- operational errors +# + +# 50 - ENETDOWN +msgid "Network is down" +msgstr "" + +# 51 - ENETUNREACH +msgid "Network is unreachable" +msgstr "" + +# 52 - ENETRESET +msgid "Network dropped connection on reset" +msgstr "" + +# 53 - ECONNABORTED +msgid "Software caused connection abort" +msgstr "" + +# 54 - ECONNRESET +msgid "Connection reset by peer" +msgstr "" + +# 55 - ENOBUFS +msgid "No buffer space available" +msgstr "" + +# 56 - EISCONN +msgid "Socket is already connected" +msgstr "" + +# 57 - ENOTCONN +msgid "Socket is not connected" +msgstr "" + +# 58 - ESHUTDOWN +msgid "Can't send after socket shutdown" +msgstr "" + +# 59 - ETOOMANYREFS +msgid "Too many references: can't splice" +msgstr "" + +# 60 - ETIMEDOUT +msgid "Operation timed out" +msgstr "" + +# 61 - ECONNREFUSED +msgid "Connection refused" +msgstr "" + +# 62 - ELOOP +msgid "Too many levels of symbolic links" +msgstr "" + +# 63 - ENAMETOOLONG +msgid "File name too long" +msgstr "" + +# +# should be rearranged +# + +# 64 - EHOSTDOWN +msgid "Host is down" +msgstr "" + +# 65 - EHOSTUNREACH +msgid "No route to host" +msgstr "" + +# 66 - ENOTEMPTY +msgid "Directory not empty" +msgstr "" + +# +# quotas & mush +# + +# 67 - EPROCLIM +msgid "Too many processes" +msgstr "" + +# 68 - EUSERS +msgid "Too many users" +msgstr "" + +# 69 - EDQUOT +msgid "Disc quota exceeded" +msgstr "" + +# +# Network File System +# + +# 70 - ESTALE +msgid "Stale NFS file handle" +msgstr "" + +# 71 - EREMOTE +msgid "Too many levels of remote in path" +msgstr "" + +# 72 - EBADRPC +msgid "RPC struct is bad" +msgstr "" + +# 73 - ERPCMISMATCH +msgid "RPC version wrong" +msgstr "" + +# 74 - EPROGUNAVAIL +msgid "RPC prog. not avail" +msgstr "" + +# 75 - EPROGMISMATCH +msgid "Program version wrong" +msgstr "" + +# 76 - EPROCUNAVAIL +msgid "Bad procedure for program" +msgstr "" + +# 77 - ENOLCK +msgid "No locks available" +msgstr "" + +# 78 - ENOSYS +msgid "Function not implemented" +msgstr "" + +# 79 - EFTYPE +msgid "Inappropriate file type or format" +msgstr "" + +# 80 - EAUTH +msgid "Authentication error" +msgstr "" + +# 81 - ENEEDAUTH +msgid "Need authenticator" +msgstr "" + +# 82 - EIDRM +msgid "Identifier removed" +msgstr "" + +# 83 - ENOMSG +msgid "No message of desired type" +msgstr "" + +# 84 - EOVERFLOW +msgid "Value too large to be stored in data type" +msgstr "" + +# 85 - ECANCELED +msgid "Operation canceled" +msgstr "" + +# 86 - EILSEQ +msgid "Illegal byte sequence" +msgstr "" + +# 87 - ENOATTR +msgid "Attribute not found" +msgstr "" + +# +# General +# + +# 88 - EDOOFUS +msgid "Programming error" +msgstr "" + +# 89 - EBADMSG +msgid "Bad message" +msgstr "" + +# 90 - EMULTIHOP +msgid "Multihop attempted" +msgstr "" + +# 91 - ENOLINK +msgid "Link has been severed" +msgstr "" + +# 92 - EPROTO +msgid "Protocol error" +msgstr "" + +# 93 - ENOTCAPABLE +msgid "Capabilities insufficient" +msgstr "" + +# 94 - ECAPMODE +msgid "Not permitted in capability mode" +msgstr "" + +# 95 - ENOTRECOVERABLE +msgid "State not recoverable" +msgstr "" + +# 96 - EOWNERDEAD +msgid "Previous owner died" +msgstr "" + +# 97 - EINTEGRITY +msgid "Integrity check failed" +msgstr "" diff --git a/contrib/libxo/tests/xo/Makefile.am b/contrib/libxo/tests/xo/Makefile.am new file mode 100644 index 000000000000..1f3636d9345d --- /dev/null +++ b/contrib/libxo/tests/xo/Makefile.am @@ -0,0 +1,83 @@ +# +# $Id$ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +AM_CFLAGS = -I${top_srcdir} -I${top_srcdir}/libxo + +# Ick: maintained by hand! +TEST_CASES = \ +xo_01.sh \ +xo_02.sh + +# TEST_CASES := $(shell cd ${srcdir} ; echo *.c ) + +EXTRA_DIST = \ + ${TEST_CASES} \ + ${addprefix saved/, ${TEST_CASES:.sh=.T.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.T.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.XP.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.XP.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.JP.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.JP.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.HP.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.HP.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.X.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.X.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.J.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.J.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.H.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.H.out}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.HIPx.err}} \ + ${addprefix saved/, ${TEST_CASES:.sh=.HIPx.out}} + +S2O = | ${SED} '1,/@@/d' + +all: + +#TEST_TRACE = set -x ; + +XO=../../xo/xo + +TEST_ONE = \ + ${CHECKER} sh ${srcdir}/$$base.sh "${XO} --libxo:W$$fmt" ${TEST_OPTS} \ + > out/$$base.$$fmt.out 2> out/$$base.$$fmt.err ; \ + ${DIFF} -Nu ${srcdir}/saved/$$base.$$fmt.out out/$$base.$$fmt.out ${S2O} ; \ + ${DIFF} -Nu ${srcdir}/saved/$$base.$$fmt.err out/$$base.$$fmt.err ${S2O} + +TEST_FORMATS = T XP JP HP X J H HIPx + +test tests: ${bin_PROGRAMS} + @${MKDIR} -p out + -@ ${TEST_TRACE} (for test in ${TEST_CASES} ; do \ + base=`${BASENAME} $$test .sh` ; \ + (for fmt in ${TEST_FORMATS}; do \ + echo "... $$test ... $$fmt ..."; \ + ${TEST_ONE}; \ + true; \ + done) \ + done) + +one: + -@(test=${TEST_CASE}; data=${TEST_DATA}; ${TEST_ONE} ; true) + +accept: + -@(for test in ${TEST_CASES} ; do \ + base=`${BASENAME} $$test .sh` ; \ + (for fmt in ${TEST_FORMATS}; do \ + echo "... $$test ... $$fmt ..."; \ + ${CP} out/$$base.$$fmt.out ${srcdir}/saved/$$base.$$fmt.out ; \ + ${CP} out/$$base.$$fmt.err ${srcdir}/saved/$$base.$$fmt.err ; \ + done) \ + done) + +CLEANFILES = +CLEANDIRS = out + +clean-local: + rm -rf ${CLEANDIRS} diff --git a/contrib/libxo/tests/xo/saved/xo_01.H.err b/contrib/libxo/tests/xo/saved/xo_01.H.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.H.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.H.out b/contrib/libxo/tests/xo/saved/xo_01.H.out new file mode 100644 index 000000000000..a8b0e4783c8d --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.H.out @@ -0,0 +1 @@ +<div class="line"><div class="text">Item </div><div class="data" data-tag="name">one</div><div class="text"> is </div><div class="label">number</div><div class="padding"> </div><div class="data" data-tag="value">001</div><div class="text">, </div><div class="label">color</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="color">red</div></div><div class="line"><div class="text">Item </div><div class="data" data-tag="name">two</div><div class="text"> is </div><div class="label">number</div><div class="padding"> </div><div class="data" data-tag="value">002</div><div class="text">, </div><div class="label">color</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="color">blue</div></div><div class="line"><div class="text">Item </div><div class="data" data-tag="name">three</div><div class="text"> is </div><div class="label">number</div><div class="padding"> </div><div class="data" data-tag="value">003</div><div class="text">, </div><div class="label">color</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="color">green</div></div><div class="line"><div class="text">Item </div><div class="data" data-tag="name">four</div><div class="text"> is </div><div class="label">number</div><div class="padding"> </div><div class="data" data-tag="value">004</div><div class="text">, </div><div class="label">color</div><div class="decoration">:</div><div class="padding"> </div><div class="data" data-tag="color">yellow</div></div><div class="padding"> </div><div class="line"><div class="data" data-tag="address">0xdeadbeef</div><div class="text">..</div><div class="data" data-tag="foo">1</div></div><div class="padding"> </div><div class="line"><div class="data" data-tag="address">0xdeadbeef</div><div class="text">..</div><div class="data" data-tag="foo">1</div></div><div class="padding"> </div><div class="line"><div class="data" data-tag="address">0xdeadbeef</div><div class="text">..</div><div class="data" data-tag="foo">1</div></div><div class="padding"> </div><div class="line"><div class="data" data-tag="address">0xdeadbeef</div><div class="text">..</div><div class="data" data-tag="foo">1</div></div><div class="line"><div class="text">partial line</div><div class="text"> -- rest of line</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_01.HIPx.err b/contrib/libxo/tests/xo/saved/xo_01.HIPx.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.HIPx.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.HIPx.out b/contrib/libxo/tests/xo/saved/xo_01.HIPx.out new file mode 100644 index 000000000000..51d57cd731f0 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.HIPx.out @@ -0,0 +1,80 @@ +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name" data-xpath="/top/item/name">one</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value" data-xpath="/top/item[name = 'one']/value">001</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color" data-xpath="/top/item[name = 'one']/color">red</div> +</div> +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name" data-xpath="/top/item/name">two</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value" data-xpath="/top/item[name = 'two']/value">002</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color" data-xpath="/top/item[name = 'two']/color">blue</div> +</div> +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name" data-xpath="/top/item/name">three</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value" data-xpath="/top/item[name = 'three']/value">003</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color" data-xpath="/top/item[name = 'three']/color">green</div> +</div> +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name" data-xpath="/top/item/name">four</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value" data-xpath="/top/item[name = 'four']/value">004</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color" data-xpath="/top/item[name = 'four']/color">yellow</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address" data-xpath="/anchor/address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo" data-xpath="/anchor/foo">1</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address" data-xpath="/anchor/address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo" data-xpath="/anchor/foo">1</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address" data-xpath="/anchor/address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo" data-xpath="/anchor/foo">1</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address" data-xpath="/anchor/address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo" data-xpath="/anchor/foo">1</div> +</div> +<div class="line"> + <div class="text">partial line</div> + <div class="text"> -- rest of line</div> +</div> diff --git a/contrib/libxo/tests/xo/saved/xo_01.HP.err b/contrib/libxo/tests/xo/saved/xo_01.HP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.HP.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.HP.out b/contrib/libxo/tests/xo/saved/xo_01.HP.out new file mode 100644 index 000000000000..1f8bce7047c7 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.HP.out @@ -0,0 +1,80 @@ +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name">one</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value">001</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color">red</div> +</div> +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name">two</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value">002</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color">blue</div> +</div> +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name">three</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value">003</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color">green</div> +</div> +<div class="line"> + <div class="text">Item </div> + <div class="data" data-tag="name">four</div> + <div class="text"> is </div> + <div class="label">number</div> + <div class="padding"> </div> + <div class="data" data-tag="value">004</div> + <div class="text">, </div> + <div class="label">color</div> + <div class="decoration">:</div> + <div class="padding"> </div> + <div class="data" data-tag="color">yellow</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo">1</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo">1</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo">1</div> +</div> + <div class="padding"> </div> +<div class="line"> + <div class="data" data-tag="address">0xdeadbeef</div> + <div class="text">..</div> + <div class="data" data-tag="foo">1</div> +</div> +<div class="line"> + <div class="text">partial line</div> + <div class="text"> -- rest of line</div> +</div> diff --git a/contrib/libxo/tests/xo/saved/xo_01.J.err b/contrib/libxo/tests/xo/saved/xo_01.J.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.J.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.J.out b/contrib/libxo/tests/xo/saved/xo_01.J.out new file mode 100644 index 000000000000..a372383b2f90 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.J.out @@ -0,0 +1 @@ +"top": {"item": {"name":"one","value":1,"color":"red"}, "item": {"name":"two","value":2,"color":"blue"}, "item": {"name":"three","value":3,"color":"green"}, "item": {"name":"four","value":4,"color":"yellow"}, "anchor": {"address":"0xdeadbeef","foo":1}, "anchor": {"address":"0xdeadbeef","foo":1}, "anchor": {"address":"0xdeadbeef","foo":1}, "anchor": {"address":"0xdeadbeef","foo":1}}
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_01.JP.err b/contrib/libxo/tests/xo/saved/xo_01.JP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.JP.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.JP.out b/contrib/libxo/tests/xo/saved/xo_01.JP.out new file mode 100644 index 000000000000..80c2b311b90e --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.JP.out @@ -0,0 +1,38 @@ +"top": { + "item": { + "name": "one", + "value": 1, + "color": "red" + }, + "item": { + "name": "two", + "value": 2, + "color": "blue" + }, + "item": { + "name": "three", + "value": 3, + "color": "green" + }, + "item": { + "name": "four", + "value": 4, + "color": "yellow" + }, + "anchor": { + "address": "0xdeadbeef", + "foo": 1 + }, + "anchor": { + "address": "0xdeadbeef", + "foo": 1 + }, + "anchor": { + "address": "0xdeadbeef", + "foo": 1 + }, + "anchor": { + "address": "0xdeadbeef", + "foo": 1 + } +}
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_01.T.err b/contrib/libxo/tests/xo/saved/xo_01.T.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.T.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.T.out b/contrib/libxo/tests/xo/saved/xo_01.T.out new file mode 100644 index 000000000000..731603a03d80 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.T.out @@ -0,0 +1,9 @@ +Item one is number 001, color: red +Item two is number 002, color: blue +Item three is number 003, color: green +Item four is number 004, color: yellow + 0xdeadbeef..1 + 0xdeadbeef..1 + 0xdeadbeef..1 + 0xdeadbeef..1 +partial line -- rest of line diff --git a/contrib/libxo/tests/xo/saved/xo_01.X.err b/contrib/libxo/tests/xo/saved/xo_01.X.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.X.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.X.out b/contrib/libxo/tests/xo/saved/xo_01.X.out new file mode 100644 index 000000000000..ffe77fa3cfcd --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.X.out @@ -0,0 +1 @@ +<top><item><name>one</name><value>1</value><color>red</color></item><item><name>two</name><value>2</value><color>blue</color></item><item><name>three</name><value>3</value><color>green</color></item><item><name>four</name><value>4</value><color>yellow</color></item><anchor><address>0xdeadbeef</address><foo>1</foo></anchor><anchor><address>0xdeadbeef</address><foo>1</foo></anchor><anchor><address>0xdeadbeef</address><foo>1</foo></anchor><anchor><address>0xdeadbeef</address><foo>1</foo></anchor></top>
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_01.XP.err b/contrib/libxo/tests/xo/saved/xo_01.XP.err new file mode 100644 index 000000000000..e69de29bb2d1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.XP.err diff --git a/contrib/libxo/tests/xo/saved/xo_01.XP.out b/contrib/libxo/tests/xo/saved/xo_01.XP.out new file mode 100644 index 000000000000..a9d3951f3eb9 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_01.XP.out @@ -0,0 +1,38 @@ +<top> + <item> + <name>one</name> + <value>1</value> + <color>red</color> + </item> + <item> + <name>two</name> + <value>2</value> + <color>blue</color> + </item> + <item> + <name>three</name> + <value>3</value> + <color>green</color> + </item> + <item> + <name>four</name> + <value>4</value> + <color>yellow</color> + </item> + <anchor> + <address>0xdeadbeef</address> + <foo>1</foo> + </anchor> + <anchor> + <address>0xdeadbeef</address> + <foo>1</foo> + </anchor> + <anchor> + <address>0xdeadbeef</address> + <foo>1</foo> + </anchor> + <anchor> + <address>0xdeadbeef</address> + <foo>1</foo> + </anchor> +</top> diff --git a/contrib/libxo/tests/xo/saved/xo_02.H.err b/contrib/libxo/tests/xo/saved/xo_02.H.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.H.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.H.out b/contrib/libxo/tests/xo/saved/xo_02.H.out new file mode 100644 index 000000000000..3eb4ec6a1b85 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.H.out @@ -0,0 +1 @@ +<div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">test</div></div><div class="line"><div class="text">Answer:</div><div class="text">The capital of </div><div class="data" data-tag="state">North Carolina</div><div class="text"> is </div><div class="data" data-tag="city">Raleigh</div></div><div class="line"><div class="text">First </div><div class="data" data-tag="tag">value1</div><div class="text"> </div><div class="text">and then </div><div class="data" data-tag="tag">value2</div></div><div class="line"><div class="text">Machine </div><div class="data" data-tag="name">red</div><div class="text"> has </div><div class="data" data-tag="memory">55</div></div><div class="line"><div class="text">Machine </div><div class="data" data-tag="name">green</div><div class="text"> has </div><div class="data" data-tag="memory">55</div></div><div class="line"><div class="text">Machine </div><div class="data" data-tag="name">blue</div><div class="text"> has </div><div class="data" data-tag="memory">55</div></div>
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_02.HIPx.err b/contrib/libxo/tests/xo/saved/xo_02.HIPx.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.HIPx.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.HIPx.out b/contrib/libxo/tests/xo/saved/xo_02.HIPx.out new file mode 100644 index 000000000000..7a78a6b542cd --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.HIPx.out @@ -0,0 +1,83 @@ +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/a/b/c/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/a/b/c/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/a/b/c/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/a/b/c/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/a/b/c/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/a/b/c/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/d/e/f/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/d/e/f/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/a/b/c/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/a/b/c/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/a/b/c/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/a/b/c/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">test</div> +</div> +<div class="line"> + <div class="text">Answer:</div> + <div class="text">The capital of </div> + <div class="data" data-tag="state" data-xpath="/state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city" data-xpath="/city">Raleigh</div> +</div> +<div class="line"> + <div class="text">First </div> + <div class="data" data-tag="tag" data-xpath="/tag">value1</div> + <div class="text"> </div> + <div class="text">and then </div> + <div class="data" data-tag="tag" data-xpath="/tag">value2</div> +</div> +<div class="line"> + <div class="text">Machine </div> + <div class="data" data-tag="name" data-xpath="/name">red</div> + <div class="text"> has </div> + <div class="data" data-tag="memory" data-xpath="/memory">55</div> +</div> +<div class="line"> + <div class="text">Machine </div> + <div class="data" data-tag="name" data-xpath="/name">green</div> + <div class="text"> has </div> + <div class="data" data-tag="memory" data-xpath="/memory">55</div> +</div> +<div class="line"> + <div class="text">Machine </div> + <div class="data" data-tag="name" data-xpath="/name">blue</div> + <div class="text"> has </div> + <div class="data" data-tag="memory" data-xpath="/memory">55</div> +</div> diff --git a/contrib/libxo/tests/xo/saved/xo_02.HP.err b/contrib/libxo/tests/xo/saved/xo_02.HP.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.HP.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.HP.out b/contrib/libxo/tests/xo/saved/xo_02.HP.out new file mode 100644 index 000000000000..3e97e691540c --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.HP.out @@ -0,0 +1,83 @@ +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">test</div> +</div> +<div class="line"> + <div class="text">Answer:</div> + <div class="text">The capital of </div> + <div class="data" data-tag="state">North Carolina</div> + <div class="text"> is </div> + <div class="data" data-tag="city">Raleigh</div> +</div> +<div class="line"> + <div class="text">First </div> + <div class="data" data-tag="tag">value1</div> + <div class="text"> </div> + <div class="text">and then </div> + <div class="data" data-tag="tag">value2</div> +</div> +<div class="line"> + <div class="text">Machine </div> + <div class="data" data-tag="name">red</div> + <div class="text"> has </div> + <div class="data" data-tag="memory">55</div> +</div> +<div class="line"> + <div class="text">Machine </div> + <div class="data" data-tag="name">green</div> + <div class="text"> has </div> + <div class="data" data-tag="memory">55</div> +</div> +<div class="line"> + <div class="text">Machine </div> + <div class="data" data-tag="name">blue</div> + <div class="text"> has </div> + <div class="data" data-tag="memory">55</div> +</div> diff --git a/contrib/libxo/tests/xo/saved/xo_02.J.err b/contrib/libxo/tests/xo/saved/xo_02.J.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.J.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.J.out b/contrib/libxo/tests/xo/saved/xo_02.J.out new file mode 100644 index 000000000000..f11f784416b3 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.J.out @@ -0,0 +1,7 @@ +{"a": {"b": {"c": {"state":"North Carolina","city":"Raleigh","state":"North Carolina","city":"Raleigh"}}}} +{"a": {"b": {"c": {"state":"North Carolina","city":"Raleigh"}}}} +{"a": {"b": {"c": {"state":"North Carolina","city":"Raleigh", "d": {"e": {"f": {"state":"North Carolina","city":"Raleigh"}}},"state":"North Carolina","city":"Raleigh"}}}} +"a": {"b": {"c": {"state":"North Carolina","city":"Raleigh"}}}{"a": {"b": {"c": {"state":"North Carolina","city":"Raleigh"}}}} +{ } +"answer": {"state":"North Carolina","city":"Raleigh"}{"top": {"data": {"tag":"value1""tag":"value2"}}} +"machine": [{"name":"red","memory":"55"}, {"name":"green","memory":"55"}, {"name":"blue","memory":"55"}]
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_02.JP.err b/contrib/libxo/tests/xo/saved/xo_02.JP.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.JP.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.JP.out b/contrib/libxo/tests/xo/saved/xo_02.JP.out new file mode 100644 index 000000000000..c540731430a4 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.JP.out @@ -0,0 +1,84 @@ +{ + "a": { + "b": { + "c": { + "state": "North Carolina", + "city": "Raleigh", + "state": "North Carolina", + "city": "Raleigh" + } + } + } +} +{ + "a": { + "b": { + "c": { + "state": "North Carolina", + "city": "Raleigh" + } + } + } +} +{ + "a": { + "b": { + "c": { + "state": "North Carolina", + "city": "Raleigh", + "d": { + "e": { + "f": { + "state": "North Carolina", + "city": "Raleigh" + } + } + }, + "state": "North Carolina", + "city": "Raleigh" + } + } + } +} +"a": { + "b": { + "c": { + "state": "North Carolina", + "city": "Raleigh" + } + } +}{ + "a": { + "b": { + "c": { + "state": "North Carolina", + "city": "Raleigh" + } + } + } +} +{ } +"answer": { +"state": "North Carolina", +"city": "Raleigh" +}{ + "top": { + "data": { + "tag": "value1" "tag": "value2" + } + } +} +"machine": [ + { + "name": "red", + "memory": "55" + }, + { + "name": "green", + "memory": "55" + }, + { + "name": "blue", + "memory": "55" + } +]
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_02.T.err b/contrib/libxo/tests/xo/saved/xo_02.T.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.T.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.T.out b/contrib/libxo/tests/xo/saved/xo_02.T.out new file mode 100644 index 000000000000..2eea241963fe --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.T.out @@ -0,0 +1,14 @@ +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +The capital of North Carolina is Raleigh +test +Answer:The capital of North Carolina is Raleigh +First value1 and then value2 +Machine red has 55 +Machine green has 55 +Machine blue has 55 diff --git a/contrib/libxo/tests/xo/saved/xo_02.X.err b/contrib/libxo/tests/xo/saved/xo_02.X.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.X.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.X.out b/contrib/libxo/tests/xo/saved/xo_02.X.out new file mode 100644 index 000000000000..40052cf59b8f --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.X.out @@ -0,0 +1 @@ +<a><b><c><state>North Carolina</state><city>Raleigh</city><state>North Carolina</state><city>Raleigh</city></c></b></a><a><b><c><state>North Carolina</state><city>Raleigh</city></c></b></a><a><b><c><state>North Carolina</state><city>Raleigh</city><d><e><f><state>North Carolina</state><city>Raleigh</city></f></e></d><state>North Carolina</state><city>Raleigh</city></c></b></a><a><b><c><state>North Carolina</state><city>Raleigh</city></c></b></a><a><b><c><state>North Carolina</state><city>Raleigh</city></c></b></a><answer><state>North Carolina</state><city>Raleigh</city></answer><top><data><tag>value1</tag><tag>value2</tag></data></top><machine><name>red</name><memory>55</memory></machine><machine><name>green</name><memory>55</memory></machine><machine><name>blue</name><memory>55</memory></machine>
\ No newline at end of file diff --git a/contrib/libxo/tests/xo/saved/xo_02.XP.err b/contrib/libxo/tests/xo/saved/xo_02.XP.err new file mode 100644 index 000000000000..1a570eea55a1 --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.XP.err @@ -0,0 +1,26 @@ +Usage: xo [options] format [fields] + --close <path> Close tags for the given path + --close-instance <name> Close an open instance name + --close-list <name> Close an open list name + --continuation OR -C Output belongs on same line as previous output + --depth <num> Set the depth for pretty printing + --help Display this help text + --html OR -H Generate HTML output + --instance OR -I <name> Wrap in an instance of the given name + --json OR -J Generate JSON output + --leading-xpath <path> OR -l <path> Add a prefix to generated XPaths (HTML) + --not-first Indicate this object is not the first (JSON) + --open <path> Open tags for the given path + --open-instance <name> Open an instance given by name + --open-list <name> Open a list given by name + --option <opts> -or -O <opts> Give formatting options + --pretty OR -p Make 'pretty' output (add indent, newlines) + --style <style> OR -s <style> Generate given style (xml, json, text, html) + --text OR -T Generate text output (the default style) + --top-wrap Generate a top-level object wrapper (JSON) + --version Display version information + --warn OR -W Display warnings in text on stderr + --warn-xml Display warnings in xml on stdout + --wrap <path> Wrap output in a set of containers + --xml OR -X Generate XML output + --xpath Add XPath data to HTML output diff --git a/contrib/libxo/tests/xo/saved/xo_02.XP.out b/contrib/libxo/tests/xo/saved/xo_02.XP.out new file mode 100644 index 000000000000..6477af08ef1c --- /dev/null +++ b/contrib/libxo/tests/xo/saved/xo_02.XP.out @@ -0,0 +1,74 @@ +<a> + <b> + <c> + <state>North Carolina</state> + <city>Raleigh</city> + <state>North Carolina</state> + <city>Raleigh</city> + </c> + </b> +</a> +<a> + <b> + <c> + <state>North Carolina</state> + <city>Raleigh</city> + </c> + </b> +</a> +<a> + <b> + <c> + <state>North Carolina</state> + <city>Raleigh</city> + <d> + <e> + <f> + <state>North Carolina</state> + <city>Raleigh</city> + </f> + </e> + </d> + <state>North Carolina</state> + <city>Raleigh</city> + </c> + </b> +</a> +<a> + <b> + <c> + <state>North Carolina</state> + <city>Raleigh</city> + </c> + </b> +</a> +<a> + <b> + <c> + <state>North Carolina</state> + <city>Raleigh</city> + </c> + </b> +</a> +<answer> +<state>North Carolina</state> +<city>Raleigh</city> +</answer> +<top> + <data> + <tag>value1</tag> + <tag>value2</tag> + </data> +</top> + <machine> + <name>red</name> + <memory>55</memory> + </machine> + <machine> + <name>green</name> + <memory>55</memory> + </machine> + <machine> + <name>blue</name> + <memory>55</memory> + </machine> diff --git a/contrib/libxo/tests/xo/xo_01.sh b/contrib/libxo/tests/xo/xo_01.sh new file mode 100644 index 000000000000..472c58c48050 --- /dev/null +++ b/contrib/libxo/tests/xo/xo_01.sh @@ -0,0 +1,36 @@ +# +# $Id$ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +XO=$1 +shift + +XOP="${XO} --warn --depth 1 --leading-xpath /top" + +${XO} --open top + +NF= +for i in one:1:red two:2:blue three:3:green four:4:yellow ; do + set `echo $i | sed 's/:/ /g'` + ${XOP} ${NF} --wrap item \ + 'Item {k:name} is {Lw:number}{:value/%03d/%d}, {Lwc:color}{:color}\n' \ + $1 $2 $3 + NF=--not-first +done + +XOAN="${XO} --wrap anchor --not-first --warn --depth 1" +${XOAN} "{[:18}{:address/%p}..{:foo/%u}{]:}\n" 0xdeadbeef 1 +${XOAN} "{[:/18}{:address/%p}..{:foo/%u}{]:}\n" 0xdeadbeef 1 +${XOAN} "{[:/%d}{:address/%p}..{:foo/%u}{]:}\n" 18 0xdeadbeef 1 +${XOAN} "{[:/%s}{:address/%p}..{:foo/%u}{]:}\n" 18 0xdeadbeef 1 + +${XO} "partial line" +${XO} -C " -- rest of line\n" + +${XO} --close top diff --git a/contrib/libxo/tests/xo/xo_02.sh b/contrib/libxo/tests/xo/xo_02.sh new file mode 100644 index 000000000000..3f4917a62603 --- /dev/null +++ b/contrib/libxo/tests/xo/xo_02.sh @@ -0,0 +1,57 @@ +# +# $Id$ +# +# Copyright 2019, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +XO=$1 +shift + +XOP="${XO} --warn" + +# This is testing --wrap, --open, --close, --top-wrap, etc, so +# the output is not a single valid document + +set -- 'The capital of {:state} is {:city}\n' 'North Carolina' Raleigh + +${XOP} --top-wrap --open a/b/c "$@" +${XOP} --top-wrap --close a/b/c --not-first "$@" + +${XOP} --top-wrap --wrap a/b/c "$@" + +${XOP} --top-wrap --open a/b/c "$@" +${XOP} --depth 4 --not-first --wrap d/e/f "$@" +${XOP} --top-wrap --close a/b/c --not-first "$@" + +${XOP} --wrap a/b/c "$@" + +${XOP} --top-wrap --wrap a/b/c "$@" + +${XOP} --top-wrap "test\n" + +${XOP} --open answer +${XOP} "Answer:" +${XOP} --continuation "$@" +${XOP} --close answer + +${XOP} --top-wrap --open top/data +${XOP} --depth 2 'First {:tag} ' value1 +${XOP} --depth 2 --continuation 'and then {:tag}\n' value2 +${XOP} --top-wrap --close top/data + + +${XOP} --help + +${XOP} --open-list machine +NF= +for name in red green blue; do + ${XOP} --depth 1 $NF --open-instance machine + ${XOP} --depth 2 "Machine {k:name} has {:memory}\n" $name 55 + ${XOP} --depth 1 --close-instance machine + NF=--not-first +done +${XOP} $NF --close-list machine diff --git a/contrib/libxo/warnings.mk b/contrib/libxo/warnings.mk new file mode 100644 index 000000000000..c07ac37a988c --- /dev/null +++ b/contrib/libxo/warnings.mk @@ -0,0 +1,57 @@ +# +# $Id$ +# +# Copyright 2011, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. +# +# Commonly used sets of warnings +# + +MIN_WARNINGS?= -W -Wall + +LOW_WARNINGS?= ${MIN_WARNINGS} \ + -Wstrict-prototypes \ + -Wmissing-prototypes \ + -Wpointer-arith + +MEDIUM_WARNINGS?= ${LOW_WARNINGS} -Werror + +HIGH_WARNINGS?= ${MEDIUM_WARNINGS} \ + -Waggregate-return \ + -Wcast-align \ + -Wcast-qual \ + -Wchar-subscripts \ + -Wcomment \ + -Wformat \ + -Wimplicit \ + -Wmissing-declarations \ + -Wnested-externs \ + -Wparentheses \ + -Wreturn-type \ + -Wshadow \ + -Wswitch \ + -Wtrigraphs \ + -Wuninitialized \ + -Wunused \ + -Wwrite-strings + +HIGHER_WARNINGS?= ${HIGH_WARNINGS} \ + -Winline \ + -Wbad-function-cast \ + -Wpacked \ + -Wpadded \ + -Wstrict-aliasing + +ifeq "${LIBXO_WARNINGS}" "HIGH" +WARNINGS += ${HIGH_WARNINGS} +else +WARNINGS += ${LOW_WARNINGS} +endif + +ifeq "${GCC_WARNINGS}" "yes" +WARNINGS += -fno-inline-functions-called-once +endif diff --git a/contrib/libxo/xo/Makefile.am b/contrib/libxo/xo/Makefile.am new file mode 100644 index 000000000000..ca01de33ca70 --- /dev/null +++ b/contrib/libxo/xo/Makefile.am @@ -0,0 +1,43 @@ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +if LIBXO_WARNINGS_HIGH +LIBXO_WARNINGS = HIGH +endif +include ${top_srcdir}/warnings.mk + +AM_CFLAGS = \ + -DLIBXO_XMLSOFT_NEED_PRIVATE \ + -I${top_builddir} \ + -I${top_srcdir} \ + -I${top_srcdir}/libxo \ + ${WARNINGS} + +LIBS = \ + ${LIBXO_LIBS} + +bin_PROGRAMS = xo + +xo_SOURCES = xo.c +#xo_LDADD = ../libxo/libxo.la +#xo_LDFLAGS = -static + +LDADD = \ + ${top_builddir}/libxo/libxo.la + +if HAVE_HUMANIZE_NUMBER +LDADD += -lutil +endif + +man_MANS = xo.1 + +EXTRA_DIST = xo.1 + +install-data-hook: + for file in ${man_MANS}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man1dir}/$$file ; done diff --git a/contrib/libxo/xo/xo.1 b/contrib/libxo/xo/xo.1 new file mode 100644 index 000000000000..c3d062f750f1 --- /dev/null +++ b/contrib/libxo/xo/xo.1 @@ -0,0 +1,211 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt XO 1 +.Os +.Sh NAME +.Nm xo +.Nd emit formatted output based on format string and arguments +.Sh SYNOPSIS +.Nm +.Op Fl options +.Op Ar argument... +.Sh DESCRIPTION +The +.Nm +utility allows command line access to the functionality of +the +.Nm libxo +library. +Using +.Nm , +shell scripts can emit +.Em XML , +.Em JSON , +or +.Em HTML +using the same commands that emit text output. +.Pp +.Bl -tag -width indent +.It Ic --close Ar path +Close tags for the given path +.It Ic -C | Ic --continuation +Indicates this output is a continuation of the previous output data +and should appear on the same line. +This is allows HTML output to be constructed correctly. +.It Ic --depth Ar num +Set the depth for pretty printing +.It Ic --help +Display help text +.It Ic -H | Ic --html +Generate HTML output +.It Ic -J | Ic --json +Generate JSON output +.It Ic --leading-xpath Ar path +Add a prefix to generated XPaths (HTML) +.It Ic --not-first +Indicate that this content is not the first in a series of sibling +objects, which is vital information for "JSON" output, which requires +a comma between such objects. +.It Ic --open Ar path +Open tags for the given path +.It Ic -p | Ic --pretty +Make 'pretty' output (add indent, newlines) +.It Ic --style Ar style +Generate given style (xml, json, text, html) +.It Ic -T | Ic --text +Generate text output (the default style) +.It Ic --top-warp +Indicates the entire object should be placed inside a top-level +object wrapper, specifically when generating JSON output. +.It Ic --version +Display version information +.It Ic -W | Ic --warn +Display warnings in text on stderr +.It Ic --warn-xml +Display warnings in xml on stdout +.It Ic --wrap Ar path +Wrap output in a set of containers +.It Ic -X | Ic --xml +Generate XML output +.It Ic --xpath +Add XPath data to HTML output +.El +.Pp +The +.Nm +utility accepts a format string suitable for +.Xr xo_emit 3 +and a set of zero or more arguments used to supply data for that string. +.Pp +In addition, +.Nm +accepts any of the +.Nm libxo +options listed in +.Xr xo_options 7 . +.Sh EXAMPLES +In this example, +.Nm +is used to emit the same data encoded in text and then in XML by +adding the "-p" (pretty) and "-X" (XML output) flags: +.Bd -literal -offset indent + % xo 'The {:product} is {:status}\\n' stereo "in route" + The stereo is in route + % xo -p -X 'The {:product} is {:status}\\n' stereo "in route" + <product>stereo</product> + <status>in route</status> +.Ed +.Pp +In this example, the output from a +.Nm +command is shown in several styles: +.Bd -literal -offset indent + xo "The {k:name} weighs {:weight/%d} pounds.\\n" fish 6 +.Pp + TEXT: + The fish weighs 6 pounds. + XML: + <name>fish</name> + <weight>6</weight> + JSON: + "name": "fish", + "weight": 6 + HTML: + <div class="line"> + <div class="text">The </div> + <div class="data" data-tag="name">fish</div> + <div class="text"> weighs </div> + <div class="data" data-tag="weight">6</div> + <div class="text"> pounds.</div> + </div> +.Ed +.Pp +The +.Fl "-wrap <path>" +option can be used to wrap emitted content in a +specific hierarchy. +The path is a set of hierarchical names separated +by the '/' character. +.Bd -literal -offset indent + xo --wrap top/a/b/c '{:tag}' value +.Pp + XML: + <top> + <a> + <b> + <c> + <tag>value</tag> + </c> + </b> + </a> + </top> + JSON: + "top": { + "a": { + "b": { + "c": { + "tag": "value" + } + } + } + } +.Ed +.Pp +The +.Fl "\-open <path>" +and +.Fl "\-close <path>" +can be used to emit +hierarchical information without the matching close and open +tag. +This allows a shell script to emit open tags, data, and +then close tags. +The +.Fl \-depth +option may be used to set the +depth for indentation. +The +.Fl "\-leading-xpath" +may be used to +prepend data to the XPath values used for HTML output style. +.Bd -literal -offset indent + #!/bin/sh + xo --open top/data + xo --depth 2 '{:tag}' value + xo --close top/data +.Pp + XML: + <top> + <data> + <tag>value</tag> + </data> + </top> + JSON: + "top": { + "data": { + "tag": "value" + } + } +.Ed +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xo_emit 3 , +.Xr xo_options 7 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/xo/xo.c b/contrib/libxo/xo/xo.c new file mode 100644 index 000000000000..6d45c9ce5bae --- /dev/null +++ b/contrib/libxo/xo/xo.c @@ -0,0 +1,555 @@ +/* + * Copyright (c) 2014-2019, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2014 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <stdarg.h> +#include <string.h> + +#include "xo_config.h" +#include "xo.h" +#include "xo_explicit.h" + +#include <getopt.h> /* Include after xo.h for testing */ + +#ifndef UNUSED +#define UNUSED __attribute__ ((__unused__)) +#endif /* UNUSED */ + +static int opt_warn; /* Enable warnings */ + +static char **save_argv; +static char **checkpoint_argv; + +static char * +next_arg (void) +{ + char *cp = *save_argv; + + if (cp == NULL) + xo_errx(1, "missing argument"); + + save_argv += 1; + return cp; +} + +static void +prep_arg (char *fmt) +{ + char *cp, *fp; + + for (cp = fp = fmt; *cp; cp++, fp++) { + if (*cp != '\\') { + if (cp != fp) + *fp = *cp; + continue; + } + + switch (*++cp) { + case 'n': + *fp = '\n'; + break; + + case 'r': + *fp = '\r'; + break; + + case 'b': + *fp = '\b'; + break; + + case 'e': + *fp = '\e'; + break; + + default: + *fp = *cp; + } + } + + *fp = '\0'; +} + +static void +checkpoint (xo_handle_t *xop UNUSED, va_list vap UNUSED, int restore) +{ + if (restore) + save_argv = checkpoint_argv; + else + checkpoint_argv = save_argv; +} + +/* + * Our custom formatter is responsible for combining format string pieces + * with our command line arguments to build strings. This involves faking + * some printf-style logic. + */ +static xo_ssize_t +formatter (xo_handle_t *xop, char *buf, xo_ssize_t bufsiz, + const char *fmt, va_list vap UNUSED) +{ + int lflag UNUSED = 0; /* Parse long flag, though currently ignored */ + int hflag = 0, jflag = 0, tflag = 0, + zflag = 0, qflag = 0, star1 = 0, star2 = 0; + int rc = 0; + int w1 = 0, w2 = 0; + const char *cp; + + for (cp = fmt + 1; *cp; cp++) { + if (*cp == 'l') + lflag += 1; + else if (*cp == 'h') + hflag += 1; + else if (*cp == 'j') + jflag += 1; + else if (*cp == 't') + tflag += 1; + else if (*cp == 'z') + zflag += 1; + else if (*cp == 'q') + qflag += 1; + else if (*cp == '*') { + if (star1 == 0) + star1 = 1; + else + star2 = 1; + } else if (strchr("diouxXDOUeEfFgGaAcCsSp", *cp) != NULL) + break; + else if (*cp == 'n' || *cp == 'v') { + if (opt_warn) + xo_error_h(xop, "unsupported format: '%s'", fmt); + return -1; + } + } + + char fc = *cp; + + /* Handle "%*.*s" */ + if (star1) + w1 = strtol(next_arg(), NULL, 0); + if (star2 > 1) + w2 = strtol(next_arg(), NULL, 0); + + if (fc == 'D' || fc == 'O' || fc == 'U') + lflag = 1; + + if (strchr("diD", fc) != NULL) { + long long value = strtoll(next_arg(), NULL, 0); + if (star1 && star2) + rc = snprintf(buf, bufsiz, fmt, w1, w2, value); + else if (star1) + rc = snprintf(buf, bufsiz, fmt, w1, value); + else + rc = snprintf(buf, bufsiz, fmt, value); + + } else if (strchr("ouxXOUp", fc) != NULL) { + unsigned long long value = strtoull(next_arg(), NULL, 0); + if (star1 && star2) + rc = snprintf(buf, bufsiz, fmt, w1, w2, value); + else if (star1) + rc = snprintf(buf, bufsiz, fmt, w1, value); + else + rc = snprintf(buf, bufsiz, fmt, value); + + } else if (strchr("eEfFgGaA", fc) != NULL) { + double value = strtold(next_arg(), NULL); + if (star1 && star2) + rc = snprintf(buf, bufsiz, fmt, w1, w2, value); + else if (star1) + rc = snprintf(buf, bufsiz, fmt, w1, value); + else + rc = snprintf(buf, bufsiz, fmt, value); + + } else if (fc == 'C' || fc == 'c' || fc == 'S' || fc == 's') { + char *value = next_arg(); + if (star1 && star2) + rc = snprintf(buf, bufsiz, fmt, w1, w2, value); + else if (star1) + rc = snprintf(buf, bufsiz, fmt, w1, value); + else + rc = snprintf(buf, bufsiz, fmt, value); + } + + return rc; +} + +static void +print_version (void) +{ + fprintf(stderr, "libxo version %s%s\n", + xo_version, xo_version_extra); + fprintf(stderr, "xo version %s%s\n", + LIBXO_VERSION, LIBXO_VERSION_EXTRA); +} + +static void +print_help (void) +{ + fprintf(stderr, +"Usage: xo [options] format [fields]\n" +" --close <path> Close tags for the given path\n" +" --close-instance <name> Close an open instance name\n" +" --close-list <name> Close an open list name\n" +" --continuation OR -C Output belongs on same line as previous output\n" +" --depth <num> Set the depth for pretty printing\n" +" --help Display this help text\n" +" --html OR -H Generate HTML output\n" +" --instance OR -I <name> Wrap in an instance of the given name\n" +" --json OR -J Generate JSON output\n" +" --leading-xpath <path> OR -l <path> " + "Add a prefix to generated XPaths (HTML)\n" +" --not-first Indicate this object is not the first (JSON)\n" +" --open <path> Open tags for the given path\n" +" --open-instance <name> Open an instance given by name\n" +" --open-list <name> Open a list given by name\n" +" --option <opts> -or -O <opts> Give formatting options\n" +" --pretty OR -p Make 'pretty' output (add indent, newlines)\n" +" --style <style> OR -s <style> " + "Generate given style (xml, json, text, html)\n" +" --text OR -T Generate text output (the default style)\n" +" --top-wrap Generate a top-level object wrapper (JSON)\n" +" --version Display version information\n" +" --warn OR -W Display warnings in text on stderr\n" +" --warn-xml Display warnings in xml on stdout\n" +" --wrap <path> Wrap output in a set of containers\n" +" --xml OR -X Generate XML output\n" +" --xpath Add XPath data to HTML output\n"); +} + +static struct opts { + int o_close_instance; + int o_close_list; + int o_depth; + int o_help; + int o_not_first; + int o_open_instance; + int o_open_list; + int o_top_wrap; + int o_version; + int o_warn_xml; + int o_wrap; + int o_xpath; +} opts; + +static struct option long_opts[] = { + { "close", required_argument, NULL, 'c' }, + { "close-instance", required_argument, &opts.o_close_instance, 1 }, + { "close-list", required_argument, &opts.o_close_list, 1 }, + { "continuation", no_argument, NULL, 'C' }, + { "depth", required_argument, &opts.o_depth, 1 }, + { "help", no_argument, &opts.o_help, 1 }, + { "html", no_argument, NULL, 'H' }, + { "instance", required_argument, NULL, 'I' }, + { "json", no_argument, NULL, 'J' }, + { "leading-xpath", required_argument, NULL, 'l' }, + { "not-first", no_argument, &opts.o_not_first, 1 }, + { "open", required_argument, NULL, 'o' }, + { "open-instance", required_argument, &opts.o_open_instance, 1 }, + { "open-list", required_argument, &opts.o_open_list, 1 }, + { "option", required_argument, NULL, 'O' }, + { "pretty", no_argument, NULL, 'p' }, + { "style", required_argument, NULL, 's' }, + { "text", no_argument, NULL, 'T' }, + { "top-wrap", no_argument, &opts.o_top_wrap, 1 }, + { "xml", no_argument, NULL, 'X' }, + { "xpath", no_argument, &opts.o_xpath, 1 }, + { "version", no_argument, &opts.o_version, 1 }, + { "warn", no_argument, NULL, 'W' }, + { "warn-xml", no_argument, &opts.o_warn_xml, 1 }, + { "wrap", required_argument, &opts.o_wrap, 1 }, + { NULL, 0, NULL, 0 } +}; + +int +main (int argc UNUSED, char **argv) +{ + char *fmt = NULL, *cp, *np; + char *opt_opener = NULL, *opt_closer = NULL, *opt_wrapper = NULL; + char *opt_options = NULL; + char *opt_instance = NULL; + char *opt_name = NULL; + xo_state_t new_state = 0; + int opt_depth = 0; + int opt_not_first = 0; + int opt_top_wrap = 0; + int rc; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + while ((rc = getopt_long(argc, argv, "Cc:HJl:O:o:ps:TXW", + long_opts, NULL)) != -1) { + switch (rc) { + case 'C': + xo_set_flags(NULL, XOF_CONTINUATION); + break; + + case 'c': + opt_closer = optarg; + xo_set_flags(NULL, XOF_IGNORE_CLOSE); + break; + + case 'H': + xo_set_style(NULL, XO_STYLE_HTML); + break; + + case 'I': + opt_instance = optarg; + break; + + case 'J': + xo_set_style(NULL, XO_STYLE_JSON); + break; + + case 'l': + xo_set_leading_xpath(NULL, optarg); + break; + + case 'O': + opt_options = optarg; + break; + + case 'o': + opt_opener = optarg; + break; + + case 'p': + xo_set_flags(NULL, XOF_PRETTY); + break; + + case 's': + if (xo_set_style_name(NULL, optarg) < 0) + xo_errx(1, "unknown style: %s", optarg); + break; + + case 'T': + xo_set_style(NULL, XO_STYLE_TEXT); + break; + + case 'X': + xo_set_style(NULL, XO_STYLE_XML); + break; + + case 'W': + opt_warn = 1; + xo_set_flags(NULL, XOF_WARN); + break; + + case ':': + xo_errx(1, "missing argument"); + break; + + case 0: + if (opts.o_depth) { + opt_depth = atoi(optarg); + + } else if (opts.o_help) { + print_help(); + return 1; + + } else if (opts.o_not_first) { + opt_not_first = 1; + + } else if (opts.o_xpath) { + xo_set_flags(NULL, XOF_XPATH); + + } else if (opts.o_version) { + print_version(); + return 0; + + } else if (opts.o_warn_xml) { + opt_warn = 1; + xo_set_flags(NULL, XOF_WARN | XOF_WARN_XML); + + } else if (opts.o_wrap) { + opt_wrapper = optarg; + + } else if (opts.o_top_wrap) { + opt_top_wrap = 1; + + } else if (opts.o_open_list) { + if (opt_name) + xo_errx(1, "only one open/close list/instance allowed: %s", + optarg); + + opt_name = optarg; + new_state = XSS_OPEN_LIST; + + } else if (opts.o_open_instance) { + if (opt_name) + xo_errx(1, "only one open/close list/instance allowed: %s", + optarg); + + opt_name = optarg; + new_state = XSS_OPEN_INSTANCE; + + } else if (opts.o_close_list) { + if (opt_name) + xo_errx(1, "only one open/close list/instance allowed: %s", + optarg); + + opt_name = optarg; + new_state = XSS_CLOSE_LIST; + + } else if (opts.o_close_instance) { + if (opt_name) + xo_errx(1, "only one open/close list/instance allowed: %s", + optarg); + + opt_name = optarg; + new_state = XSS_CLOSE_INSTANCE; + + } else { + print_help(); + return 1; + } + + bzero(&opts, sizeof(opts)); /* Reset all the options */ + break; + + default: + print_help(); + return 1; + } + } + + argc -= optind; + argv += optind; + + if (opt_options) { + rc = xo_set_options(NULL, opt_options); + if (rc < 0) + xo_errx(1, "invalid options: %s", opt_options); + } + + xo_set_formatter(NULL, formatter, checkpoint); + xo_set_flags(NULL, XOF_NO_VA_ARG | XOF_NO_TOP | XOF_NO_CLOSE); + + /* + * If we have some explicit state change, handle it + */ + if (new_state) { + if (opt_depth > 0) + xo_set_depth(NULL, opt_depth); + + if (opt_not_first) + xo_set_flags(NULL, XOF_NOT_FIRST); + + xo_explicit_transition(NULL, new_state, opt_name, 0); + xo_finish(); + exit(0); + } + + fmt = *argv++; + if (opt_opener == NULL && opt_closer == NULL && fmt == NULL) { + print_help(); + return 1; + } + + if (opt_top_wrap) { + /* If we have a closing path, we'll be one extra level deeper */ + if (opt_closer && xo_get_style(NULL) == XO_STYLE_JSON) + opt_depth += 1; + else + xo_clear_flags(NULL, XOF_NO_TOP); + } + + if (opt_closer) { + opt_depth += 1; + for (cp = opt_closer; cp && *cp; cp = np) { + np = strchr(cp, '/'); + if (np == NULL) + break; + np += 1; + opt_depth += 1; + } + } + + if (opt_depth > 0) + xo_set_depth(NULL, opt_depth); + + if (opt_not_first) + xo_set_flags(NULL, XOF_NOT_FIRST); + + /* If there's an opening hierarchy, open each element as a container */ + if (opt_opener) { + for (cp = opt_opener; cp && *cp; cp = np) { + np = strchr(cp, '/'); + if (np) + *np = '\0'; + xo_open_container(cp); + if (np) + np += 1; + } + } + + /* If there's an wrapper hierarchy, open each element as a container */ + if (opt_wrapper) { + for (cp = opt_wrapper; cp && *cp; cp = np) { + np = strchr(cp, '/'); + if (np) + *np = '\0'; + xo_open_container(cp); + if (np) + *np++ = '/'; /* Put it back */ + } + } + + if (opt_instance) + xo_open_instance(opt_instance); + + /* If there's a format string, call xo_emit to emit the contents */ + if (fmt && *fmt) { + save_argv = argv; + prep_arg(fmt); + xo_emit(fmt); /* This call does the real formatting */ + } + + if (opt_instance) + xo_close_instance(opt_instance); + + /* If there's an wrapper hierarchy, close each element's container */ + while (opt_wrapper) { + np = strrchr(opt_wrapper, '/'); + xo_close_container(np ? np + 1 : opt_wrapper); + if (np) + *np = '\0'; + else + opt_wrapper = NULL; + } + + /* Remember to undo the depth before calling xo_finish() */ + opt_depth = (opt_closer && opt_top_wrap) ? -1 : 0; + + /* If there's an closing hierarchy, close each element's container */ + while (opt_closer) { + np = strrchr(opt_closer, '/'); + xo_close_container(np ? np + 1 : opt_closer); + if (np) + *np = '\0'; + else + opt_closer = NULL; + } + + /* If there's a closer and a wrapper, we need to clean it up */ + if (opt_depth) { + xo_set_depth(NULL, opt_depth); + xo_clear_flags(NULL, XOF_NO_TOP); + } + + /* If we're wrapping the entire content, skip the closer */ + if (opt_top_wrap && opt_opener) + xo_set_flags(NULL, XOF_NO_TOP); + + xo_finish(); + + return 0; +} diff --git a/contrib/libxo/xohtml/Makefile.am b/contrib/libxo/xohtml/Makefile.am new file mode 100644 index 000000000000..cd4cac2bc22f --- /dev/null +++ b/contrib/libxo/xohtml/Makefile.am @@ -0,0 +1,42 @@ +# +# Copyright 2015, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +man_MANS = xohtml.1 + +EXTERNAL_FILES = \ + external/jquery.js \ + external/jquery.qtip.css \ + external/jquery.qtip.js + +INTERNAL_FILES = \ + xohtml.js \ + xohtml.css + +EXTRA_DIST = \ + xohtml.1 \ + xohtml.sh.in \ + ${INTERNAL_FILES} \ + ${EXTERNAL_FILES} + +install-exec-hook: + install xohtml.sh ${DESTDIR}${bindir}/xohtml + mkdir -p ${DESTDIR}${XO_SHAREDIR}/external + for file in ${INTERNAL_FILES}; do \ + install ${srcdir}/$$file ${DESTDIR}${XO_SHAREDIR} ; done + for file in ${EXTERNAL_FILES}; do \ + install ${srcdir}/$$file ${DESTDIR}${XO_SHAREDIR}/external ; done + +uninstall-hook: + for file in ${INTERNAL_FILES} ${EXTERNAL_FILES}; do \ + rm ${DESTDIR}${XO_SHAREDIR}/$$file ; done + rmdir ${DESTDIR}${XO_SHAREDIR}/external + rm -f ${DESTDIR}${bindir}/xohtml + +install-data-hook: + for file in ${man_MANS}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man1dir}/$$file ; done diff --git a/contrib/libxo/xohtml/external/jquery.js b/contrib/libxo/xohtml/external/jquery.js new file mode 100644 index 000000000000..eda55db3559a --- /dev/null +++ b/contrib/libxo/xohtml/external/jquery.js @@ -0,0 +1,9300 @@ +/*! + * jQuery JavaScript Library v1.7 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Thu Nov 3 16:18:21 2011 -0400 + */ +(function( window, undefined ) { + +// Use the correct document accordingly with window argument (sandbox) +var document = window.document, + navigator = window.navigator, + location = window.location; +var jQuery = (function() { + +// Define a local copy of jQuery +var jQuery = function( selector, context ) { + // The jQuery object is actually just the init constructor 'enhanced' + return new jQuery.fn.init( selector, context, rootjQuery ); + }, + + // Map over jQuery in case of overwrite + _jQuery = window.jQuery, + + // Map over the $ in case of overwrite + _$ = window.$, + + // A central reference to the root jQuery(document) + rootjQuery, + + // A simple way to check for HTML strings or ID strings + // Prioritize #id over <tag> to avoid XSS via location.hash (#9521) + quickExpr = /^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/, + + // Check if a string has a non-whitespace character in it + rnotwhite = /\S/, + + // Used for trimming whitespace + trimLeft = /^\s+/, + trimRight = /\s+$/, + + // Check for digits + rdigit = /\d/, + + // Match a standalone tag + rsingleTag = /^<(\w+)\s*\/?>(?:<\/\1>)?$/, + + // JSON RegExp + rvalidchars = /^[\],:{}\s]*$/, + rvalidescape = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, + rvalidtokens = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, + rvalidbraces = /(?:^|:|,)(?:\s*\[)+/g, + + // Useragent RegExp + rwebkit = /(webkit)[ \/]([\w.]+)/, + ropera = /(opera)(?:.*version)?[ \/]([\w.]+)/, + rmsie = /(msie) ([\w.]+)/, + rmozilla = /(mozilla)(?:.*? rv:([\w.]+))?/, + + // Matches dashed string for camelizing + rdashAlpha = /-([a-z]|[0-9])/ig, + rmsPrefix = /^-ms-/, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return ( letter + "" ).toUpperCase(); + }, + + // Keep a UserAgent string for use with jQuery.browser + userAgent = navigator.userAgent, + + // For matching the engine and version of the browser + browserMatch, + + // The deferred used on DOM ready + readyList, + + // The ready event handler + DOMContentLoaded, + + // Save a reference to some core methods + toString = Object.prototype.toString, + hasOwn = Object.prototype.hasOwnProperty, + push = Array.prototype.push, + slice = Array.prototype.slice, + trim = String.prototype.trim, + indexOf = Array.prototype.indexOf, + + // [[Class]] -> type pairs + class2type = {}; + +jQuery.fn = jQuery.prototype = { + constructor: jQuery, + init: function( selector, context, rootjQuery ) { + var match, elem, ret, doc; + + // Handle $(""), $(null), or $(undefined) + if ( !selector ) { + return this; + } + + // Handle $(DOMElement) + if ( selector.nodeType ) { + this.context = this[0] = selector; + this.length = 1; + return this; + } + + // The body element only exists once, optimize finding it + if ( selector === "body" && !context && document.body ) { + this.context = document; + this[0] = document.body; + this.selector = selector; + this.length = 1; + return this; + } + + // Handle HTML strings + if ( typeof selector === "string" ) { + // Are we dealing with HTML string or an ID? + if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = quickExpr.exec( selector ); + } + + // Verify a match, and that no context was specified for #id + if ( match && (match[1] || !context) ) { + + // HANDLE: $(html) -> $(array) + if ( match[1] ) { + context = context instanceof jQuery ? context[0] : context; + doc = ( context ? context.ownerDocument || context : document ); + + // If a single string is passed in and it's a single tag + // just do a createElement and skip the rest + ret = rsingleTag.exec( selector ); + + if ( ret ) { + if ( jQuery.isPlainObject( context ) ) { + selector = [ document.createElement( ret[1] ) ]; + jQuery.fn.attr.call( selector, context, true ); + + } else { + selector = [ doc.createElement( ret[1] ) ]; + } + + } else { + ret = jQuery.buildFragment( [ match[1] ], [ doc ] ); + selector = ( ret.cacheable ? jQuery.clone(ret.fragment) : ret.fragment ).childNodes; + } + + return jQuery.merge( this, selector ); + + // HANDLE: $("#id") + } else { + elem = document.getElementById( match[2] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id !== match[2] ) { + return rootjQuery.find( selector ); + } + + // Otherwise, we inject the element directly into the jQuery object + this.length = 1; + this[0] = elem; + } + + this.context = document; + this.selector = selector; + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || rootjQuery ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return rootjQuery.ready( selector ); + } + + if ( selector.selector !== undefined ) { + this.selector = selector.selector; + this.context = selector.context; + } + + return jQuery.makeArray( selector, this ); + }, + + // Start with an empty selector + selector: "", + + // The current version of jQuery being used + jquery: "1.7", + + // The default length of a jQuery object is 0 + length: 0, + + // The number of elements contained in the matched element set + size: function() { + return this.length; + }, + + toArray: function() { + return slice.call( this, 0 ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + return num == null ? + + // Return a 'clean' array + this.toArray() : + + // Return just the object + ( num < 0 ? this[ this.length + num ] : this[ num ] ); + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems, name, selector ) { + // Build a new jQuery matched element set + var ret = this.constructor(); + + if ( jQuery.isArray( elems ) ) { + push.apply( ret, elems ); + + } else { + jQuery.merge( ret, elems ); + } + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + ret.context = this.context; + + if ( name === "find" ) { + ret.selector = this.selector + ( this.selector ? " " : "" ) + selector; + } else if ( name ) { + ret.selector = this.selector + "." + name + "(" + selector + ")"; + } + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + // (You can seed the arguments with an array of args, but this is + // only used internally.) + each: function( callback, args ) { + return jQuery.each( this, callback, args ); + }, + + ready: function( fn ) { + // Attach the listeners + jQuery.bindReady(); + + // Add the callback + readyList.add( fn ); + + return this; + }, + + eq: function( i ) { + return i === -1 ? + this.slice( i ) : + this.slice( i, +i + 1 ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ), + "slice", slice.call(arguments).join(",") ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map(this, function( elem, i ) { + return callback.call( elem, i, elem ); + })); + }, + + end: function() { + return this.prevObject || this.constructor(null); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: [].sort, + splice: [].splice +}; + +// Give the init function the jQuery prototype for later instantiation +jQuery.fn.init.prototype = jQuery.fn; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[0] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + target = arguments[1] || {}; + // skip the boolean and the target + i = 2; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction(target) ) { + target = {}; + } + + // extend jQuery itself if only one argument is passed + if ( length === i ) { + target = this; + --i; + } + + for ( ; i < length; i++ ) { + // Only deal with non-null/undefined values + if ( (options = arguments[ i ]) != null ) { + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { + if ( copyIsArray ) { + copyIsArray = false; + clone = src && jQuery.isArray(src) ? src : []; + + } else { + clone = src && jQuery.isPlainObject(src) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend({ + noConflict: function( deep ) { + if ( window.$ === jQuery ) { + window.$ = _$; + } + + if ( deep && window.jQuery === jQuery ) { + window.jQuery = _jQuery; + } + + return jQuery; + }, + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Hold (or release) the ready event + holdReady: function( hold ) { + if ( hold ) { + jQuery.readyWait++; + } else { + jQuery.ready( true ); + } + }, + + // Handle when the DOM is ready + ready: function( wait ) { + // Either a released hold or an DOMready/load event and not yet ready + if ( (wait === true && !--jQuery.readyWait) || (wait !== true && !jQuery.isReady) ) { + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( !document.body ) { + return setTimeout( jQuery.ready, 1 ); + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.fireWith( document, [ jQuery ] ); + + // Trigger any bound ready events + if ( jQuery.fn.trigger ) { + jQuery( document ).trigger( "ready" ).unbind( "ready" ); + } + } + }, + + bindReady: function() { + if ( readyList ) { + return; + } + + readyList = jQuery.Callbacks( "once memory" ); + + // Catch cases where $(document).ready() is called after the + // browser event has already occurred. + if ( document.readyState === "complete" ) { + // Handle it asynchronously to allow scripts the opportunity to delay ready + return setTimeout( jQuery.ready, 1 ); + } + + // Mozilla, Opera and webkit nightlies currently support this event + if ( document.addEventListener ) { + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", DOMContentLoaded, false ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", jQuery.ready, false ); + + // If IE event model is used + } else if ( document.attachEvent ) { + // ensure firing before onload, + // maybe late but safe also for iframes + document.attachEvent( "onreadystatechange", DOMContentLoaded ); + + // A fallback to window.onload, that will always work + window.attachEvent( "onload", jQuery.ready ); + + // If IE and not a frame + // continually check to see if the document is ready + var toplevel = false; + + try { + toplevel = window.frameElement == null; + } catch(e) {} + + if ( document.documentElement.doScroll && toplevel ) { + doScrollCheck(); + } + } + }, + + // See test/unit/core.js for details concerning isFunction. + // Since version 1.3, DOM methods and functions like alert + // aren't supported. They return false on IE (#2968). + isFunction: function( obj ) { + return jQuery.type(obj) === "function"; + }, + + isArray: Array.isArray || function( obj ) { + return jQuery.type(obj) === "array"; + }, + + // A crude way of determining if an object is a window + isWindow: function( obj ) { + return obj && typeof obj === "object" && "setInterval" in obj; + }, + + isNumeric: function( obj ) { + return obj != null && rdigit.test( obj ) && !isNaN( obj ); + }, + + type: function( obj ) { + return obj == null ? + String( obj ) : + class2type[ toString.call(obj) ] || "object"; + }, + + isPlainObject: function( obj ) { + // Must be an Object. + // Because of IE, we also have to check the presence of the constructor property. + // Make sure that DOM nodes and window objects don't pass through, as well + if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { + return false; + } + + try { + // Not own constructor property must be Object + if ( obj.constructor && + !hasOwn.call(obj, "constructor") && + !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { + return false; + } + } catch ( e ) { + // IE8,9 Will throw exceptions on certain host objects #9897 + return false; + } + + // Own properties are enumerated firstly, so to speed up, + // if last one is own, then all properties are own. + + var key; + for ( key in obj ) {} + + return key === undefined || hasOwn.call( obj, key ); + }, + + isEmptyObject: function( obj ) { + for ( var name in obj ) { + return false; + } + return true; + }, + + error: function( msg ) { + throw msg; + }, + + parseJSON: function( data ) { + if ( typeof data !== "string" || !data ) { + return null; + } + + // Make sure leading/trailing whitespace is removed (IE can't handle it) + data = jQuery.trim( data ); + + // Attempt to parse using the native JSON parser first + if ( window.JSON && window.JSON.parse ) { + return window.JSON.parse( data ); + } + + // Make sure the incoming data is actual JSON + // Logic borrowed from http://json.org/json2.js + if ( rvalidchars.test( data.replace( rvalidescape, "@" ) + .replace( rvalidtokens, "]" ) + .replace( rvalidbraces, "")) ) { + + return ( new Function( "return " + data ) )(); + + } + jQuery.error( "Invalid JSON: " + data ); + }, + + // Cross-browser xml parsing + parseXML: function( data ) { + var xml, tmp; + try { + if ( window.DOMParser ) { // Standard + tmp = new DOMParser(); + xml = tmp.parseFromString( data , "text/xml" ); + } else { // IE + xml = new ActiveXObject( "Microsoft.XMLDOM" ); + xml.async = "false"; + xml.loadXML( data ); + } + } catch( e ) { + xml = undefined; + } + if ( !xml || !xml.documentElement || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; + }, + + noop: function() {}, + + // Evaluates a script in a global context + // Workarounds based on findings by Jim Driscoll + // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context + globalEval: function( data ) { + if ( data && rnotwhite.test( data ) ) { + // We use execScript on Internet Explorer + // We use an anonymous function so that context is window + // rather than jQuery in Firefox + ( window.execScript || function( data ) { + window[ "eval" ].call( window, data ); + } )( data ); + } + }, + + // Convert dashed to camelCase; used by the css and data modules + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + nodeName: function( elem, name ) { + return elem.nodeName && elem.nodeName.toUpperCase() === name.toUpperCase(); + }, + + // args is for internal usage only + each: function( object, callback, args ) { + var name, i = 0, + length = object.length, + isObj = length === undefined || jQuery.isFunction( object ); + + if ( args ) { + if ( isObj ) { + for ( name in object ) { + if ( callback.apply( object[ name ], args ) === false ) { + break; + } + } + } else { + for ( ; i < length; ) { + if ( callback.apply( object[ i++ ], args ) === false ) { + break; + } + } + } + + // A special, fast, case for the most common use of each + } else { + if ( isObj ) { + for ( name in object ) { + if ( callback.call( object[ name ], name, object[ name ] ) === false ) { + break; + } + } + } else { + for ( ; i < length; ) { + if ( callback.call( object[ i ], i, object[ i++ ] ) === false ) { + break; + } + } + } + } + + return object; + }, + + // Use native String.trim function wherever possible + trim: trim ? + function( text ) { + return text == null ? + "" : + trim.call( text ); + } : + + // Otherwise use our own trimming functionality + function( text ) { + return text == null ? + "" : + text.toString().replace( trimLeft, "" ).replace( trimRight, "" ); + }, + + // results is for internal usage only + makeArray: function( array, results ) { + var ret = results || []; + + if ( array != null ) { + // The window, strings (and functions) also have 'length' + // The extra typeof function check is to prevent crashes + // in Safari 2 (See: #3039) + // Tweaked logic slightly to handle Blackberry 4.7 RegExp issues #6930 + var type = jQuery.type( array ); + + if ( array.length == null || type === "string" || type === "function" || type === "regexp" || jQuery.isWindow( array ) ) { + push.call( ret, array ); + } else { + jQuery.merge( ret, array ); + } + } + + return ret; + }, + + inArray: function( elem, array, i ) { + var len; + + if ( array ) { + if ( indexOf ) { + return indexOf.call( array, elem, i ); + } + + len = array.length; + i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0; + + for ( ; i < len; i++ ) { + // Skip accessing in sparse arrays + if ( i in array && array[ i ] === elem ) { + return i; + } + } + } + + return -1; + }, + + merge: function( first, second ) { + var i = first.length, + j = 0; + + if ( typeof second.length === "number" ) { + for ( var l = second.length; j < l; j++ ) { + first[ i++ ] = second[ j ]; + } + + } else { + while ( second[j] !== undefined ) { + first[ i++ ] = second[ j++ ]; + } + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, inv ) { + var ret = [], retVal; + inv = !!inv; + + // Go through the array, only saving the items + // that pass the validator function + for ( var i = 0, length = elems.length; i < length; i++ ) { + retVal = !!callback( elems[ i ], i ); + if ( inv !== retVal ) { + ret.push( elems[ i ] ); + } + } + + return ret; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var value, key, ret = [], + i = 0, + length = elems.length, + // jquery objects are treated as arrays + isArray = elems instanceof jQuery || length !== undefined && typeof length === "number" && ( ( length > 0 && elems[ 0 ] && elems[ length -1 ] ) || length === 0 || jQuery.isArray( elems ) ) ; + + // Go through the array, translating each of the items to their + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + + // Go through every key on the object, + } else { + for ( key in elems ) { + value = callback( elems[ key ], key, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + } + + // Flatten any nested arrays + return ret.concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + if ( typeof context === "string" ) { + var tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + var args = slice.call( arguments, 2 ), + proxy = function() { + return fn.apply( context, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || proxy.guid || jQuery.guid++; + + return proxy; + }, + + // Mutifunctional method to get and set values to a collection + // The value/s can optionally be executed if it's a function + access: function( elems, key, value, exec, fn, pass ) { + var length = elems.length; + + // Setting many attributes + if ( typeof key === "object" ) { + for ( var k in key ) { + jQuery.access( elems, k, key[k], exec, fn, value ); + } + return elems; + } + + // Setting one attribute + if ( value !== undefined ) { + // Optionally, function values get executed if exec is true + exec = !pass && exec && jQuery.isFunction(value); + + for ( var i = 0; i < length; i++ ) { + fn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass ); + } + + return elems; + } + + // Getting an attribute + return length ? fn( elems[0], key ) : undefined; + }, + + now: function() { + return ( new Date() ).getTime(); + }, + + // Use of jQuery.browser is frowned upon. + // More details: http://docs.jquery.com/Utilities/jQuery.browser + uaMatch: function( ua ) { + ua = ua.toLowerCase(); + + var match = rwebkit.exec( ua ) || + ropera.exec( ua ) || + rmsie.exec( ua ) || + ua.indexOf("compatible") < 0 && rmozilla.exec( ua ) || + []; + + return { browser: match[1] || "", version: match[2] || "0" }; + }, + + sub: function() { + function jQuerySub( selector, context ) { + return new jQuerySub.fn.init( selector, context ); + } + jQuery.extend( true, jQuerySub, this ); + jQuerySub.superclass = this; + jQuerySub.fn = jQuerySub.prototype = this(); + jQuerySub.fn.constructor = jQuerySub; + jQuerySub.sub = this.sub; + jQuerySub.fn.init = function init( selector, context ) { + if ( context && context instanceof jQuery && !(context instanceof jQuerySub) ) { + context = jQuerySub( context ); + } + + return jQuery.fn.init.call( this, selector, context, rootjQuerySub ); + }; + jQuerySub.fn.init.prototype = jQuerySub.fn; + var rootjQuerySub = jQuerySub(document); + return jQuerySub; + }, + + browser: {} +}); + +// Populate the class2type map +jQuery.each("Boolean Number String Function Array Date RegExp Object".split(" "), function(i, name) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +}); + +browserMatch = jQuery.uaMatch( userAgent ); +if ( browserMatch.browser ) { + jQuery.browser[ browserMatch.browser ] = true; + jQuery.browser.version = browserMatch.version; +} + +// Deprecated, use jQuery.browser.webkit instead +if ( jQuery.browser.webkit ) { + jQuery.browser.safari = true; +} + +// IE doesn't match non-breaking spaces with \s +if ( rnotwhite.test( "\xA0" ) ) { + trimLeft = /^[\s\xA0]+/; + trimRight = /[\s\xA0]+$/; +} + +// All jQuery objects should point back to these +rootjQuery = jQuery(document); + +// Cleanup functions for the document ready method +if ( document.addEventListener ) { + DOMContentLoaded = function() { + document.removeEventListener( "DOMContentLoaded", DOMContentLoaded, false ); + jQuery.ready(); + }; + +} else if ( document.attachEvent ) { + DOMContentLoaded = function() { + // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). + if ( document.readyState === "complete" ) { + document.detachEvent( "onreadystatechange", DOMContentLoaded ); + jQuery.ready(); + } + }; +} + +// The DOM ready check for Internet Explorer +function doScrollCheck() { + if ( jQuery.isReady ) { + return; + } + + try { + // If IE is used, use the trick by Diego Perini + // http://javascript.nwbox.com/IEContentLoaded/ + document.documentElement.doScroll("left"); + } catch(e) { + setTimeout( doScrollCheck, 1 ); + return; + } + + // and execute any waiting functions + jQuery.ready(); +} + +// Expose jQuery as an AMD module, but only for AMD loaders that +// understand the issues with loading multiple versions of jQuery +// in a page that all might call define(). The loader will indicate +// they have special allowances for multiple jQuery versions by +// specifying define.amd.jQuery = true. Register as a named module, +// since jQuery can be concatenated with other files that may use define, +// but not use a proper concatenation script that understands anonymous +// AMD modules. A named AMD is safest and most robust way to register. +// Lowercase jquery is used because AMD module names are derived from +// file names, and jQuery is normally delivered in a lowercase file name. +if ( typeof define === "function" && define.amd && define.amd.jQuery ) { + define( "jquery", [], function () { return jQuery; } ); +} + +return jQuery; + +})(); + + +// String to Object flags format cache +var flagsCache = {}; + +// Convert String-formatted flags into Object-formatted ones and store in cache +function createFlags( flags ) { + var object = flagsCache[ flags ] = {}, + i, length; + flags = flags.split( /\s+/ ); + for ( i = 0, length = flags.length; i < length; i++ ) { + object[ flags[i] ] = true; + } + return object; +} + +/* + * Create a callback list using the following parameters: + * + * flags: an optional list of space-separated flags that will change how + * the callback list behaves + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible flags: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( flags ) { + + // Convert flags from String-formatted to Object-formatted + // (we check in cache first) + flags = flags ? ( flagsCache[ flags ] || createFlags( flags ) ) : {}; + + var // Actual callback list + list = [], + // Stack of fire calls for repeatable lists + stack = [], + // Last fire value (for non-forgettable lists) + memory, + // Flag to know if list is currently firing + firing, + // First callback to fire (used internally by add and fireWith) + firingStart, + // End of the loop when firing + firingLength, + // Index of currently firing callback (modified by remove if needed) + firingIndex, + // Add one or several callbacks to the list + add = function( args ) { + var i, + length, + elem, + type, + actual; + for ( i = 0, length = args.length; i < length; i++ ) { + elem = args[ i ]; + type = jQuery.type( elem ); + if ( type === "array" ) { + // Inspect recursively + add( elem ); + } else if ( type === "function" ) { + // Add if not in unique mode and callback is not in + if ( !flags.unique || !self.has( elem ) ) { + list.push( elem ); + } + } + } + }, + // Fire callbacks + fire = function( context, args ) { + args = args || []; + memory = !flags.memory || [ context, args ]; + firing = true; + firingIndex = firingStart || 0; + firingStart = 0; + firingLength = list.length; + for ( ; list && firingIndex < firingLength; firingIndex++ ) { + if ( list[ firingIndex ].apply( context, args ) === false && flags.stopOnFalse ) { + memory = true; // Mark as halted + break; + } + } + firing = false; + if ( list ) { + if ( !flags.once ) { + if ( stack && stack.length ) { + memory = stack.shift(); + self.fireWith( memory[ 0 ], memory[ 1 ] ); + } + } else if ( memory === true ) { + self.disable(); + } else { + list = []; + } + } + }, + // Actual Callbacks object + self = { + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + var length = list.length; + add( arguments ); + // Do we need to add the callbacks to the + // current firing batch? + if ( firing ) { + firingLength = list.length; + // With memory, if we're not firing then + // we should call right away, unless previous + // firing was halted (stopOnFalse) + } else if ( memory && memory !== true ) { + firingStart = length; + fire( memory[ 0 ], memory[ 1 ] ); + } + } + return this; + }, + // Remove a callback from the list + remove: function() { + if ( list ) { + var args = arguments, + argIndex = 0, + argLength = args.length; + for ( ; argIndex < argLength ; argIndex++ ) { + for ( var i = 0; i < list.length; i++ ) { + if ( args[ argIndex ] === list[ i ] ) { + // Handle firingIndex and firingLength + if ( firing ) { + if ( i <= firingLength ) { + firingLength--; + if ( i <= firingIndex ) { + firingIndex--; + } + } + } + // Remove the element + list.splice( i--, 1 ); + // If we have some unicity property then + // we only need to do this once + if ( flags.unique ) { + break; + } + } + } + } + } + return this; + }, + // Control if a given callback is in the list + has: function( fn ) { + if ( list ) { + var i = 0, + length = list.length; + for ( ; i < length; i++ ) { + if ( fn === list[ i ] ) { + return true; + } + } + } + return false; + }, + // Remove all callbacks from the list + empty: function() { + list = []; + return this; + }, + // Have the list do nothing anymore + disable: function() { + list = stack = memory = undefined; + return this; + }, + // Is it disabled? + disabled: function() { + return !list; + }, + // Lock the list in its current state + lock: function() { + stack = undefined; + if ( !memory || memory === true ) { + self.disable(); + } + return this; + }, + // Is it locked? + locked: function() { + return !stack; + }, + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( stack ) { + if ( firing ) { + if ( !flags.once ) { + stack.push( [ context, args ] ); + } + } else if ( !( flags.once && memory ) ) { + fire( context, args ); + } + } + return this; + }, + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + // To know if the callbacks have already been called at least once + fired: function() { + return !!memory; + } + }; + + return self; +}; + + + + +var // Static reference to slice + sliceDeferred = [].slice; + +jQuery.extend({ + + Deferred: function( func ) { + var doneList = jQuery.Callbacks( "once memory" ), + failList = jQuery.Callbacks( "once memory" ), + progressList = jQuery.Callbacks( "memory" ), + state = "pending", + lists = { + resolve: doneList, + reject: failList, + notify: progressList + }, + promise = { + done: doneList.add, + fail: failList.add, + progress: progressList.add, + + state: function() { + return state; + }, + + // Deprecated + isResolved: doneList.fired, + isRejected: failList.fired, + + then: function( doneCallbacks, failCallbacks, progressCallbacks ) { + deferred.done( doneCallbacks ).fail( failCallbacks ).progress( progressCallbacks ); + return this; + }, + always: function() { + return deferred.done.apply( deferred, arguments ).fail.apply( deferred, arguments ); + }, + pipe: function( fnDone, fnFail, fnProgress ) { + return jQuery.Deferred(function( newDefer ) { + jQuery.each( { + done: [ fnDone, "resolve" ], + fail: [ fnFail, "reject" ], + progress: [ fnProgress, "notify" ] + }, function( handler, data ) { + var fn = data[ 0 ], + action = data[ 1 ], + returned; + if ( jQuery.isFunction( fn ) ) { + deferred[ handler ](function() { + returned = fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise().then( newDefer.resolve, newDefer.reject, newDefer.notify ); + } else { + newDefer[ action + "With" ]( this === deferred ? newDefer : this, [ returned ] ); + } + }); + } else { + deferred[ handler ]( newDefer[ action ] ); + } + }); + }).promise(); + }, + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + if ( obj == null ) { + obj = promise; + } else { + for ( var key in promise ) { + obj[ key ] = promise[ key ]; + } + } + return obj; + } + }, + deferred = promise.promise({}), + key; + + for ( key in lists ) { + deferred[ key ] = lists[ key ].fire; + deferred[ key + "With" ] = lists[ key ].fireWith; + } + + // Handle state + deferred.done( function() { + state = "resolved"; + }, failList.disable, progressList.lock ).fail( function() { + state = "rejected"; + }, doneList.disable, progressList.lock ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( firstParam ) { + var args = sliceDeferred.call( arguments, 0 ), + i = 0, + length = args.length, + pValues = new Array( length ), + count = length, + pCount = length, + deferred = length <= 1 && firstParam && jQuery.isFunction( firstParam.promise ) ? + firstParam : + jQuery.Deferred(), + promise = deferred.promise(); + function resolveFunc( i ) { + return function( value ) { + args[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value; + if ( !( --count ) ) { + deferred.resolveWith( deferred, args ); + } + }; + } + function progressFunc( i ) { + return function( value ) { + pValues[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value; + deferred.notifyWith( promise, pValues ); + }; + } + if ( length > 1 ) { + for ( ; i < length; i++ ) { + if ( args[ i ] && args[ i ].promise && jQuery.isFunction( args[ i ].promise ) ) { + args[ i ].promise().then( resolveFunc(i), deferred.reject, progressFunc(i) ); + } else { + --count; + } + } + if ( !count ) { + deferred.resolveWith( deferred, args ); + } + } else if ( deferred !== firstParam ) { + deferred.resolveWith( deferred, length ? [ firstParam ] : [] ); + } + return promise; + } +}); + + + + +jQuery.support = (function() { + + var div = document.createElement( "div" ), + documentElement = document.documentElement, + all, + a, + select, + opt, + input, + marginDiv, + support, + fragment, + body, + testElementParent, + testElement, + testElementStyle, + tds, + events, + eventName, + i, + isSupported; + + // Preliminary tests + div.setAttribute("className", "t"); + div.innerHTML = " <link/><table></table><a href='/a' style='top:1px;float:left;opacity:.55;'>a</a><input type='checkbox'/><nav></nav>"; + + + all = div.getElementsByTagName( "*" ); + a = div.getElementsByTagName( "a" )[ 0 ]; + + // Can't get basic test support + if ( !all || !all.length || !a ) { + return {}; + } + + // First batch of supports tests + select = document.createElement( "select" ); + opt = select.appendChild( document.createElement("option") ); + input = div.getElementsByTagName( "input" )[ 0 ]; + + support = { + // IE strips leading whitespace when .innerHTML is used + leadingWhitespace: ( div.firstChild.nodeType === 3 ), + + // Make sure that tbody elements aren't automatically inserted + // IE will insert them into empty tables + tbody: !div.getElementsByTagName( "tbody" ).length, + + // Make sure that link elements get serialized correctly by innerHTML + // This requires a wrapper element in IE + htmlSerialize: !!div.getElementsByTagName( "link" ).length, + + // Get the style information from getAttribute + // (IE uses .cssText instead) + style: /top/.test( a.getAttribute("style") ), + + // Make sure that URLs aren't manipulated + // (IE normalizes it by default) + hrefNormalized: ( a.getAttribute( "href" ) === "/a" ), + + // Make sure that element opacity exists + // (IE uses filter instead) + // Use a regex to work around a WebKit issue. See #5145 + opacity: /^0.55/.test( a.style.opacity ), + + // Verify style float existence + // (IE uses styleFloat instead of cssFloat) + cssFloat: !!a.style.cssFloat, + + // Make sure unknown elements (like HTML5 elems) are handled appropriately + unknownElems: !!div.getElementsByTagName( "nav" ).length, + + // Make sure that if no value is specified for a checkbox + // that it defaults to "on". + // (WebKit defaults to "" instead) + checkOn: ( input.value === "on" ), + + // Make sure that a selected-by-default option has a working selected property. + // (WebKit defaults to false instead of true, IE too, if it's in an optgroup) + optSelected: opt.selected, + + // Test setAttribute on camelCase class. If it works, we need attrFixes when doing get/setAttribute (ie6/7) + getSetAttribute: div.className !== "t", + + // Tests for enctype support on a form(#6743) + enctype: !!document.createElement("form").enctype, + + // Will be defined later + submitBubbles: true, + changeBubbles: true, + focusinBubbles: false, + deleteExpando: true, + noCloneEvent: true, + inlineBlockNeedsLayout: false, + shrinkWrapBlocks: false, + reliableMarginRight: true + }; + + // Make sure checked status is properly cloned + input.checked = true; + support.noCloneChecked = input.cloneNode( true ).checked; + + // Make sure that the options inside disabled selects aren't marked as disabled + // (WebKit marks them as disabled) + select.disabled = true; + support.optDisabled = !opt.disabled; + + // Test to see if it's possible to delete an expando from an element + // Fails in Internet Explorer + try { + delete div.test; + } catch( e ) { + support.deleteExpando = false; + } + + if ( !div.addEventListener && div.attachEvent && div.fireEvent ) { + div.attachEvent( "onclick", function() { + // Cloning a node shouldn't copy over any + // bound event handlers (IE does this) + support.noCloneEvent = false; + }); + div.cloneNode( true ).fireEvent( "onclick" ); + } + + // Check if a radio maintains its value + // after being appended to the DOM + input = document.createElement("input"); + input.value = "t"; + input.setAttribute("type", "radio"); + support.radioValue = input.value === "t"; + + input.setAttribute("checked", "checked"); + div.appendChild( input ); + fragment = document.createDocumentFragment(); + fragment.appendChild( div.lastChild ); + + // WebKit doesn't clone checked state correctly in fragments + support.checkClone = fragment.cloneNode( true ).cloneNode( true ).lastChild.checked; + + div.innerHTML = ""; + + // Figure out if the W3C box model works as expected + div.style.width = div.style.paddingLeft = "1px"; + + // We don't want to do body-related feature tests on frameset + // documents, which lack a body. So we use + // document.getElementsByTagName("body")[0], which is undefined in + // frameset documents, while document.body isn’t. (7398) + body = document.getElementsByTagName("body")[ 0 ]; + // We use our own, invisible, body unless the body is already present + // in which case we use a div (#9239) + testElement = document.createElement( body ? "div" : "body" ); + testElementStyle = { + visibility: "hidden", + width: 0, + height: 0, + border: 0, + margin: 0, + background: "none" + }; + if ( body ) { + jQuery.extend( testElementStyle, { + position: "absolute", + left: "-999px", + top: "-999px" + }); + } + for ( i in testElementStyle ) { + testElement.style[ i ] = testElementStyle[ i ]; + } + testElement.appendChild( div ); + testElementParent = body || documentElement; + testElementParent.insertBefore( testElement, testElementParent.firstChild ); + + // Check if a disconnected checkbox will retain its checked + // value of true after appended to the DOM (IE6/7) + support.appendChecked = input.checked; + + support.boxModel = div.offsetWidth === 2; + + if ( "zoom" in div.style ) { + // Check if natively block-level elements act like inline-block + // elements when setting their display to 'inline' and giving + // them layout + // (IE < 8 does this) + div.style.display = "inline"; + div.style.zoom = 1; + support.inlineBlockNeedsLayout = ( div.offsetWidth === 2 ); + + // Check if elements with layout shrink-wrap their children + // (IE 6 does this) + div.style.display = ""; + div.innerHTML = "<div style='width:4px;'></div>"; + support.shrinkWrapBlocks = ( div.offsetWidth !== 2 ); + } + + div.innerHTML = "<table><tr><td style='padding:0;border:0;display:none'></td><td>t</td></tr></table>"; + tds = div.getElementsByTagName( "td" ); + + // Check if table cells still have offsetWidth/Height when they are set + // to display:none and there are still other visible table cells in a + // table row; if so, offsetWidth/Height are not reliable for use when + // determining if an element has been hidden directly using + // display:none (it is still safe to use offsets if a parent element is + // hidden; don safety goggles and see bug #4512 for more information). + // (only IE 8 fails this test) + isSupported = ( tds[ 0 ].offsetHeight === 0 ); + + tds[ 0 ].style.display = ""; + tds[ 1 ].style.display = "none"; + + // Check if empty table cells still have offsetWidth/Height + // (IE < 8 fail this test) + support.reliableHiddenOffsets = isSupported && ( tds[ 0 ].offsetHeight === 0 ); + div.innerHTML = ""; + + // Check if div with explicit width and no margin-right incorrectly + // gets computed margin-right based on width of container. For more + // info see bug #3333 + // Fails in WebKit before Feb 2011 nightlies + // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right + if ( document.defaultView && document.defaultView.getComputedStyle ) { + marginDiv = document.createElement( "div" ); + marginDiv.style.width = "0"; + marginDiv.style.marginRight = "0"; + div.appendChild( marginDiv ); + support.reliableMarginRight = + ( parseInt( ( document.defaultView.getComputedStyle( marginDiv, null ) || { marginRight: 0 } ).marginRight, 10 ) || 0 ) === 0; + } + + // Technique from Juriy Zaytsev + // http://perfectionkills.com/detecting-event-support-without-browser-sniffing/ + // We only care about the case where non-standard event systems + // are used, namely in IE. Short-circuiting here helps us to + // avoid an eval call (in setAttribute) which can cause CSP + // to go haywire. See: https://developer.mozilla.org/en/Security/CSP + if ( div.attachEvent ) { + for( i in { + submit: 1, + change: 1, + focusin: 1 + } ) { + eventName = "on" + i; + isSupported = ( eventName in div ); + if ( !isSupported ) { + div.setAttribute( eventName, "return;" ); + isSupported = ( typeof div[ eventName ] === "function" ); + } + support[ i + "Bubbles" ] = isSupported; + } + } + + // Run fixed position tests at doc ready to avoid a crash + // related to the invisible body in IE8 + jQuery(function() { + var container, outer, inner, table, td, offsetSupport, + conMarginTop = 1, + ptlm = "position:absolute;top:0;left:0;width:1px;height:1px;margin:0;", + vb = "visibility:hidden;border:0;", + style = "style='" + ptlm + "border:5px solid #000;padding:0;'", + html = "<div " + style + "><div></div></div>" + + "<table " + style + " cellpadding='0' cellspacing='0'>" + + "<tr><td></td></tr></table>"; + + // Reconstruct a container + body = document.getElementsByTagName("body")[0]; + if ( !body ) { + // Return for frameset docs that don't have a body + // These tests cannot be done + return; + } + + container = document.createElement("div"); + container.style.cssText = vb + "width:0;height:0;position:static;top:0;margin-top:" + conMarginTop + "px"; + body.insertBefore( container, body.firstChild ); + + // Construct a test element + testElement = document.createElement("div"); + testElement.style.cssText = ptlm + vb; + + testElement.innerHTML = html; + container.appendChild( testElement ); + outer = testElement.firstChild; + inner = outer.firstChild; + td = outer.nextSibling.firstChild.firstChild; + + offsetSupport = { + doesNotAddBorder: ( inner.offsetTop !== 5 ), + doesAddBorderForTableAndCells: ( td.offsetTop === 5 ) + }; + + inner.style.position = "fixed"; + inner.style.top = "20px"; + + // safari subtracts parent border width here which is 5px + offsetSupport.fixedPosition = ( inner.offsetTop === 20 || inner.offsetTop === 15 ); + inner.style.position = inner.style.top = ""; + + outer.style.overflow = "hidden"; + outer.style.position = "relative"; + + offsetSupport.subtractsBorderForOverflowNotVisible = ( inner.offsetTop === -5 ); + offsetSupport.doesNotIncludeMarginInBodyOffset = ( body.offsetTop !== conMarginTop ); + + body.removeChild( container ); + testElement = container = null; + + jQuery.extend( support, offsetSupport ); + }); + + testElement.innerHTML = ""; + testElementParent.removeChild( testElement ); + + // Null connected elements to avoid leaks in IE + testElement = fragment = select = opt = body = marginDiv = div = input = null; + + return support; +})(); + +// Keep track of boxModel +jQuery.boxModel = jQuery.support.boxModel; + + + + +var rbrace = /^(?:\{.*\}|\[.*\])$/, + rmultiDash = /([A-Z])/g; + +jQuery.extend({ + cache: {}, + + // Please use with caution + uuid: 0, + + // Unique for each copy of jQuery on the page + // Non-digits removed to match rinlinejQuery + expando: "jQuery" + ( jQuery.fn.jquery + Math.random() ).replace( /\D/g, "" ), + + // The following elements throw uncatchable exceptions if you + // attempt to add expando properties to them. + noData: { + "embed": true, + // Ban all objects except for Flash (which handle expandos) + "object": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000", + "applet": true + }, + + hasData: function( elem ) { + elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ]; + return !!elem && !isEmptyDataObject( elem ); + }, + + data: function( elem, name, data, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var privateCache, thisCache, ret, + internalKey = jQuery.expando, + getByName = typeof name === "string", + + // We have to handle DOM nodes and JS objects differently because IE6-7 + // can't GC object references properly across the DOM-JS boundary + isNode = elem.nodeType, + + // Only DOM nodes need the global jQuery cache; JS object data is + // attached directly to the object so GC can occur automatically + cache = isNode ? jQuery.cache : elem, + + // Only defining an ID for JS objects if its cache already exists allows + // the code to shortcut on the same path as a DOM node with no cache + id = isNode ? elem[ jQuery.expando ] : elem[ jQuery.expando ] && jQuery.expando, + isEvents = name === "events"; + + // Avoid doing any more work than we need to when trying to get data on an + // object that has no data at all + if ( (!id || !cache[id] || (!isEvents && !pvt && !cache[id].data)) && getByName && data === undefined ) { + return; + } + + if ( !id ) { + // Only DOM nodes need a new unique ID for each element since their data + // ends up in the global cache + if ( isNode ) { + elem[ jQuery.expando ] = id = ++jQuery.uuid; + } else { + id = jQuery.expando; + } + } + + if ( !cache[ id ] ) { + cache[ id ] = {}; + + // Avoids exposing jQuery metadata on plain JS objects when the object + // is serialized using JSON.stringify + if ( !isNode ) { + cache[ id ].toJSON = jQuery.noop; + } + } + + // An object can be passed to jQuery.data instead of a key/value pair; this gets + // shallow copied over onto the existing cache + if ( typeof name === "object" || typeof name === "function" ) { + if ( pvt ) { + cache[ id ] = jQuery.extend( cache[ id ], name ); + } else { + cache[ id ].data = jQuery.extend( cache[ id ].data, name ); + } + } + + privateCache = thisCache = cache[ id ]; + + // jQuery data() is stored in a separate object inside the object's internal data + // cache in order to avoid key collisions between internal data and user-defined + // data. + if ( !pvt ) { + if ( !thisCache.data ) { + thisCache.data = {}; + } + + thisCache = thisCache.data; + } + + if ( data !== undefined ) { + thisCache[ jQuery.camelCase( name ) ] = data; + } + + // Users should not attempt to inspect the internal events object using jQuery.data, + // it is undocumented and subject to change. But does anyone listen? No. + if ( isEvents && !thisCache[ name ] ) { + return privateCache.events; + } + + // Check for both converted-to-camel and non-converted data property names + // If a data property was specified + if ( getByName ) { + + // First Try to find as-is property data + ret = thisCache[ name ]; + + // Test for null|undefined property data + if ( ret == null ) { + + // Try to find the camelCased property + ret = thisCache[ jQuery.camelCase( name ) ]; + } + } else { + ret = thisCache; + } + + return ret; + }, + + removeData: function( elem, name, pvt /* Internal Use Only */ ) { + if ( !jQuery.acceptData( elem ) ) { + return; + } + + var thisCache, i, l, + + // Reference to internal data cache key + internalKey = jQuery.expando, + + isNode = elem.nodeType, + + // See jQuery.data for more information + cache = isNode ? jQuery.cache : elem, + + // See jQuery.data for more information + id = isNode ? elem[ jQuery.expando ] : jQuery.expando; + + // If there is already no cache entry for this object, there is no + // purpose in continuing + if ( !cache[ id ] ) { + return; + } + + if ( name ) { + + thisCache = pvt ? cache[ id ] : cache[ id ].data; + + if ( thisCache ) { + + // Support space separated names + if ( jQuery.isArray( name ) ) { + name = name; + } else if ( name in thisCache ) { + name = [ name ]; + } else { + + // split the camel cased version by spaces + name = jQuery.camelCase( name ); + if ( name in thisCache ) { + name = [ name ]; + } else { + name = name.split( " " ); + } + } + + for ( i = 0, l = name.length; i < l; i++ ) { + delete thisCache[ name[i] ]; + } + + // If there is no data left in the cache, we want to continue + // and let the cache object itself get destroyed + if ( !( pvt ? isEmptyDataObject : jQuery.isEmptyObject )( thisCache ) ) { + return; + } + } + } + + // See jQuery.data for more information + if ( !pvt ) { + delete cache[ id ].data; + + // Don't destroy the parent cache unless the internal data object + // had been the only thing left in it + if ( !isEmptyDataObject(cache[ id ]) ) { + return; + } + } + + // Browsers that fail expando deletion also refuse to delete expandos on + // the window, but it will allow it on all other JS objects; other browsers + // don't care + // Ensure that `cache` is not a window object #10080 + if ( jQuery.support.deleteExpando || !cache.setInterval ) { + delete cache[ id ]; + } else { + cache[ id ] = null; + } + + // We destroyed the cache and need to eliminate the expando on the node to avoid + // false lookups in the cache for entries that no longer exist + if ( isNode ) { + // IE does not allow us to delete expando properties from nodes, + // nor does it have a removeAttribute function on Document nodes; + // we must handle all of these cases + if ( jQuery.support.deleteExpando ) { + delete elem[ jQuery.expando ]; + } else if ( elem.removeAttribute ) { + elem.removeAttribute( jQuery.expando ); + } else { + elem[ jQuery.expando ] = null; + } + } + }, + + // For internal use only. + _data: function( elem, name, data ) { + return jQuery.data( elem, name, data, true ); + }, + + // A method for determining if a DOM node can handle the data expando + acceptData: function( elem ) { + if ( elem.nodeName ) { + var match = jQuery.noData[ elem.nodeName.toLowerCase() ]; + + if ( match ) { + return !(match === true || elem.getAttribute("classid") !== match); + } + } + + return true; + } +}); + +jQuery.fn.extend({ + data: function( key, value ) { + var parts, attr, name, + data = null; + + if ( typeof key === "undefined" ) { + if ( this.length ) { + data = jQuery.data( this[0] ); + + if ( this[0].nodeType === 1 && !jQuery._data( this[0], "parsedAttrs" ) ) { + attr = this[0].attributes; + for ( var i = 0, l = attr.length; i < l; i++ ) { + name = attr[i].name; + + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.substring(5) ); + + dataAttr( this[0], name, data[ name ] ); + } + } + jQuery._data( this[0], "parsedAttrs", true ); + } + } + + return data; + + } else if ( typeof key === "object" ) { + return this.each(function() { + jQuery.data( this, key ); + }); + } + + parts = key.split("."); + parts[1] = parts[1] ? "." + parts[1] : ""; + + if ( value === undefined ) { + data = this.triggerHandler("getData" + parts[1] + "!", [parts[0]]); + + // Try to fetch any internally stored data first + if ( data === undefined && this.length ) { + data = jQuery.data( this[0], key ); + data = dataAttr( this[0], key, data ); + } + + return data === undefined && parts[1] ? + this.data( parts[0] ) : + data; + + } else { + return this.each(function() { + var $this = jQuery( this ), + args = [ parts[0], value ]; + + $this.triggerHandler( "setData" + parts[1] + "!", args ); + jQuery.data( this, key, value ); + $this.triggerHandler( "changeData" + parts[1] + "!", args ); + }); + } + }, + + removeData: function( key ) { + return this.each(function() { + jQuery.removeData( this, key ); + }); + } +}); + +function dataAttr( elem, key, data ) { + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + + var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); + + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = data === "true" ? true : + data === "false" ? false : + data === "null" ? null : + jQuery.isNumeric( data ) ? parseFloat( data ) : + rbrace.test( data ) ? jQuery.parseJSON( data ) : + data; + } catch( e ) {} + + // Make sure we set the data so it isn't changed later + jQuery.data( elem, key, data ); + + } else { + data = undefined; + } + } + + return data; +} + +// checks a cache object for emptiness +function isEmptyDataObject( obj ) { + for ( var name in obj ) { + + // if the public data object is empty, the private is still empty + if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) { + continue; + } + if ( name !== "toJSON" ) { + return false; + } + } + + return true; +} + + + + +function handleQueueMarkDefer( elem, type, src ) { + var deferDataKey = type + "defer", + queueDataKey = type + "queue", + markDataKey = type + "mark", + defer = jQuery._data( elem, deferDataKey ); + if ( defer && + ( src === "queue" || !jQuery._data(elem, queueDataKey) ) && + ( src === "mark" || !jQuery._data(elem, markDataKey) ) ) { + // Give room for hard-coded callbacks to fire first + // and eventually mark/queue something else on the element + setTimeout( function() { + if ( !jQuery._data( elem, queueDataKey ) && + !jQuery._data( elem, markDataKey ) ) { + jQuery.removeData( elem, deferDataKey, true ); + defer.fire(); + } + }, 0 ); + } +} + +jQuery.extend({ + + _mark: function( elem, type ) { + if ( elem ) { + type = ( type || "fx" ) + "mark"; + jQuery._data( elem, type, (jQuery._data( elem, type ) || 0) + 1 ); + } + }, + + _unmark: function( force, elem, type ) { + if ( force !== true ) { + type = elem; + elem = force; + force = false; + } + if ( elem ) { + type = type || "fx"; + var key = type + "mark", + count = force ? 0 : ( (jQuery._data( elem, key ) || 1) - 1 ); + if ( count ) { + jQuery._data( elem, key, count ); + } else { + jQuery.removeData( elem, key, true ); + handleQueueMarkDefer( elem, type, "mark" ); + } + } + }, + + queue: function( elem, type, data ) { + var q; + if ( elem ) { + type = ( type || "fx" ) + "queue"; + q = jQuery._data( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !q || jQuery.isArray(data) ) { + q = jQuery._data( elem, type, jQuery.makeArray(data) ); + } else { + q.push( data ); + } + } + return q || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + fn = queue.shift(), + hooks = {}; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + } + + if ( fn ) { + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + jQuery._data( elem, type + ".run", hooks ); + fn.call( elem, function() { + jQuery.dequeue( elem, type ); + }, hooks ); + } + + if ( !queue.length ) { + jQuery.removeData( elem, type + "queue " + type + ".run", true ); + handleQueueMarkDefer( elem, type, "queue" ); + } + } +}); + +jQuery.fn.extend({ + queue: function( type, data ) { + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + } + + if ( data === undefined ) { + return jQuery.queue( this[0], type ); + } + return this.each(function() { + var queue = jQuery.queue( this, type, data ); + + if ( type === "fx" && queue[0] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + }); + }, + dequeue: function( type ) { + return this.each(function() { + jQuery.dequeue( this, type ); + }); + }, + // Based off of the plugin by Clint Helfers, with permission. + // http://blindsignals.com/index.php/2009/07/jquery-delay/ + delay: function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = setTimeout( next, time ); + hooks.stop = function() { + clearTimeout( timeout ); + }; + }); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, object ) { + if ( typeof type !== "string" ) { + object = type; + type = undefined; + } + type = type || "fx"; + var defer = jQuery.Deferred(), + elements = this, + i = elements.length, + count = 1, + deferDataKey = type + "defer", + queueDataKey = type + "queue", + markDataKey = type + "mark", + tmp; + function resolve() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + } + while( i-- ) { + if (( tmp = jQuery.data( elements[ i ], deferDataKey, undefined, true ) || + ( jQuery.data( elements[ i ], queueDataKey, undefined, true ) || + jQuery.data( elements[ i ], markDataKey, undefined, true ) ) && + jQuery.data( elements[ i ], deferDataKey, jQuery.Callbacks( "once memory" ), true ) )) { + count++; + tmp.add( resolve ); + } + } + resolve(); + return defer.promise(); + } +}); + + + + +var rclass = /[\n\t\r]/g, + rspace = /\s+/, + rreturn = /\r/g, + rtype = /^(?:button|input)$/i, + rfocusable = /^(?:button|input|object|select|textarea)$/i, + rclickable = /^a(?:rea)?$/i, + rboolean = /^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i, + getSetAttribute = jQuery.support.getSetAttribute, + nodeHook, boolHook, fixSpecified; + +jQuery.fn.extend({ + attr: function( name, value ) { + return jQuery.access( this, name, value, true, jQuery.attr ); + }, + + removeAttr: function( name ) { + return this.each(function() { + jQuery.removeAttr( this, name ); + }); + }, + + prop: function( name, value ) { + return jQuery.access( this, name, value, true, jQuery.prop ); + }, + + removeProp: function( name ) { + name = jQuery.propFix[ name ] || name; + return this.each(function() { + // try/catch handles cases where IE balks (such as removing a property on window) + try { + this[ name ] = undefined; + delete this[ name ]; + } catch( e ) {} + }); + }, + + addClass: function( value ) { + var classNames, i, l, elem, + setClass, c, cl; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).addClass( value.call(this, j, this.className) ); + }); + } + + if ( value && typeof value === "string" ) { + classNames = value.split( rspace ); + + for ( i = 0, l = this.length; i < l; i++ ) { + elem = this[ i ]; + + if ( elem.nodeType === 1 ) { + if ( !elem.className && classNames.length === 1 ) { + elem.className = value; + + } else { + setClass = " " + elem.className + " "; + + for ( c = 0, cl = classNames.length; c < cl; c++ ) { + if ( !~setClass.indexOf( " " + classNames[ c ] + " " ) ) { + setClass += classNames[ c ] + " "; + } + } + elem.className = jQuery.trim( setClass ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classNames, i, l, elem, className, c, cl; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).removeClass( value.call(this, j, this.className) ); + }); + } + + if ( (value && typeof value === "string") || value === undefined ) { + classNames = ( value || "" ).split( rspace ); + + for ( i = 0, l = this.length; i < l; i++ ) { + elem = this[ i ]; + + if ( elem.nodeType === 1 && elem.className ) { + if ( value ) { + className = (" " + elem.className + " ").replace( rclass, " " ); + for ( c = 0, cl = classNames.length; c < cl; c++ ) { + className = className.replace(" " + classNames[ c ] + " ", " "); + } + elem.className = jQuery.trim( className ); + + } else { + elem.className = ""; + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isBool = typeof stateVal === "boolean"; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( i ) { + jQuery( this ).toggleClass( value.call(this, i, this.className, stateVal), stateVal ); + }); + } + + return this.each(function() { + if ( type === "string" ) { + // toggle individual class names + var className, + i = 0, + self = jQuery( this ), + state = stateVal, + classNames = value.split( rspace ); + + while ( (className = classNames[ i++ ]) ) { + // check each className given, space seperated list + state = isBool ? state : !self.hasClass( className ); + self[ state ? "addClass" : "removeClass" ]( className ); + } + + } else if ( type === "undefined" || type === "boolean" ) { + if ( this.className ) { + // store className if set + jQuery._data( this, "__className__", this.className ); + } + + // toggle whole className + this.className = this.className || value === false ? "" : jQuery._data( this, "__className__" ) || ""; + } + }); + }, + + hasClass: function( selector ) { + var className = " " + selector + " ", + i = 0, + l = this.length; + for ( ; i < l; i++ ) { + if ( this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) > -1 ) { + return true; + } + } + + return false; + }, + + val: function( value ) { + var hooks, ret, isFunction, + elem = this[0]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.nodeName.toLowerCase() ] || jQuery.valHooks[ elem.type ]; + + if ( hooks && "get" in hooks && (ret = hooks.get( elem, "value" )) !== undefined ) { + return ret; + } + + ret = elem.value; + + return typeof ret === "string" ? + // handle most common string cases + ret.replace(rreturn, "") : + // handle cases where value is null/undef or number + ret == null ? "" : ret; + } + + return undefined; + } + + isFunction = jQuery.isFunction( value ); + + return this.each(function( i ) { + var self = jQuery(this), val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, self.val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + } else if ( typeof val === "number" ) { + val += ""; + } else if ( jQuery.isArray( val ) ) { + val = jQuery.map(val, function ( value ) { + return value == null ? "" : value + ""; + }); + } + + hooks = jQuery.valHooks[ this.nodeName.toLowerCase() ] || jQuery.valHooks[ this.type ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !("set" in hooks) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + }); + } +}); + +jQuery.extend({ + valHooks: { + option: { + get: function( elem ) { + // attributes.value is undefined in Blackberry 4.7 but + // uses .value. See #6932 + var val = elem.attributes.value; + return !val || val.specified ? elem.value : elem.text; + } + }, + select: { + get: function( elem ) { + var value, i, max, option, + index = elem.selectedIndex, + values = [], + options = elem.options, + one = elem.type === "select-one"; + + // Nothing was selected + if ( index < 0 ) { + return null; + } + + // Loop through all the selected options + i = one ? index : 0; + max = one ? index + 1 : options.length; + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Don't return options that are disabled or in a disabled optgroup + if ( option.selected && (jQuery.support.optDisabled ? !option.disabled : option.getAttribute("disabled") === null) && + (!option.parentNode.disabled || !jQuery.nodeName( option.parentNode, "optgroup" )) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + // Fixes Bug #2551 -- select.val() broken in IE after form.reset() + if ( one && !values.length && options.length ) { + return jQuery( options[ index ] ).val(); + } + + return values; + }, + + set: function( elem, value ) { + var values = jQuery.makeArray( value ); + + jQuery(elem).find("option").each(function() { + this.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0; + }); + + if ( !values.length ) { + elem.selectedIndex = -1; + } + return values; + } + } + }, + + attrFn: { + val: true, + css: true, + html: true, + text: true, + data: true, + width: true, + height: true, + offset: true + }, + + attr: function( elem, name, value, pass ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set attributes on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return undefined; + } + + if ( pass && name in jQuery.attrFn ) { + return jQuery( elem )[ name ]( value ); + } + + // Fallback to prop when attributes are not supported + if ( !("getAttribute" in elem) ) { + return jQuery.prop( elem, name, value ); + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + // All attributes are lowercase + // Grab necessary hook if one is defined + if ( notxml ) { + name = name.toLowerCase(); + hooks = jQuery.attrHooks[ name ] || ( rboolean.test( name ) ? boolHook : nodeHook ); + } + + if ( value !== undefined ) { + + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return undefined; + + } else if ( hooks && "set" in hooks && notxml && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + elem.setAttribute( name, "" + value ); + return value; + } + + } else if ( hooks && "get" in hooks && notxml && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + + ret = elem.getAttribute( name ); + + // Non-existent attributes return null, we normalize to undefined + return ret === null ? + undefined : + ret; + } + }, + + removeAttr: function( elem, value ) { + var propName, attrNames, name, l, + i = 0; + + if ( elem.nodeType === 1 ) { + attrNames = ( value || "" ).split( rspace ); + l = attrNames.length; + + for ( ; i < l; i++ ) { + name = attrNames[ i ].toLowerCase(); + propName = jQuery.propFix[ name ] || name; + + // See #9699 for explanation of this approach (setting first, then removal) + jQuery.attr( elem, name, "" ); + elem.removeAttribute( getSetAttribute ? name : propName ); + + // Set corresponding property to false for boolean attributes + if ( rboolean.test( name ) && propName in elem ) { + elem[ propName ] = false; + } + } + } + }, + + attrHooks: { + type: { + set: function( elem, value ) { + // We can't allow the type property to be changed (since it causes problems in IE) + if ( rtype.test( elem.nodeName ) && elem.parentNode ) { + jQuery.error( "type property can't be changed" ); + } else if ( !jQuery.support.radioValue && value === "radio" && jQuery.nodeName(elem, "input") ) { + // Setting the type on a radio button after the value resets the value in IE6-9 + // Reset value to it's default in case type is set after value + // This is for element creation + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + }, + // Use the value property for back compat + // Use the nodeHook for button elements in IE6/7 (#1954) + value: { + get: function( elem, name ) { + if ( nodeHook && jQuery.nodeName( elem, "button" ) ) { + return nodeHook.get( elem, name ); + } + return name in elem ? + elem.value : + null; + }, + set: function( elem, value, name ) { + if ( nodeHook && jQuery.nodeName( elem, "button" ) ) { + return nodeHook.set( elem, value, name ); + } + // Does not return so that setAttribute is also used + elem.value = value; + } + } + }, + + propFix: { + tabindex: "tabIndex", + readonly: "readOnly", + "for": "htmlFor", + "class": "className", + maxlength: "maxLength", + cellspacing: "cellSpacing", + cellpadding: "cellPadding", + rowspan: "rowSpan", + colspan: "colSpan", + usemap: "useMap", + frameborder: "frameBorder", + contenteditable: "contentEditable" + }, + + prop: function( elem, name, value ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set properties on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return undefined; + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + if ( notxml ) { + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + return ( elem[ name ] = value ); + } + + } else { + if ( hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + return elem[ name ]; + } + } + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + // elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set + // http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + var attributeNode = elem.getAttributeNode("tabindex"); + + return attributeNode && attributeNode.specified ? + parseInt( attributeNode.value, 10 ) : + rfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ? + 0 : + undefined; + } + } + } +}); + +// Add the tabIndex propHook to attrHooks for back-compat (different case is intentional) +jQuery.attrHooks.tabindex = jQuery.propHooks.tabIndex; + +// Hook for boolean attributes +boolHook = { + get: function( elem, name ) { + // Align boolean attributes with corresponding properties + // Fall back to attribute presence where some booleans are not supported + var attrNode, + property = jQuery.prop( elem, name ); + return property === true || typeof property !== "boolean" && ( attrNode = elem.getAttributeNode(name) ) && attrNode.nodeValue !== false ? + name.toLowerCase() : + undefined; + }, + set: function( elem, value, name ) { + var propName; + if ( value === false ) { + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + // value is true since we know at this point it's type boolean and not false + // Set boolean attributes to the same name and set the DOM property + propName = jQuery.propFix[ name ] || name; + if ( propName in elem ) { + // Only set the IDL specifically if it already exists on the element + elem[ propName ] = true; + } + + elem.setAttribute( name, name.toLowerCase() ); + } + return name; + } +}; + +// IE6/7 do not support getting/setting some attributes with get/setAttribute +if ( !getSetAttribute ) { + + fixSpecified = { + name: true, + id: true + }; + + // Use this for any attribute in IE6/7 + // This fixes almost every IE6/7 issue + nodeHook = jQuery.valHooks.button = { + get: function( elem, name ) { + var ret; + ret = elem.getAttributeNode( name ); + return ret && ( fixSpecified[ name ] ? ret.nodeValue !== "" : ret.specified ) ? + ret.nodeValue : + undefined; + }, + set: function( elem, value, name ) { + // Set the existing or create a new attribute node + var ret = elem.getAttributeNode( name ); + if ( !ret ) { + ret = document.createAttribute( name ); + elem.setAttributeNode( ret ); + } + return ( ret.nodeValue = value + "" ); + } + }; + + // Apply the nodeHook to tabindex + jQuery.attrHooks.tabindex.set = nodeHook.set; + + // Set width and height to auto instead of 0 on empty string( Bug #8150 ) + // This is for removals + jQuery.each([ "width", "height" ], function( i, name ) { + jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], { + set: function( elem, value ) { + if ( value === "" ) { + elem.setAttribute( name, "auto" ); + return value; + } + } + }); + }); + + // Set contenteditable to false on removals(#10429) + // Setting to empty string throws an error as an invalid value + jQuery.attrHooks.contenteditable = { + get: nodeHook.get, + set: function( elem, value, name ) { + if ( value === "" ) { + value = "false"; + } + nodeHook.set( elem, value, name ); + } + }; +} + + +// Some attributes require a special call on IE +if ( !jQuery.support.hrefNormalized ) { + jQuery.each([ "href", "src", "width", "height" ], function( i, name ) { + jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], { + get: function( elem ) { + var ret = elem.getAttribute( name, 2 ); + return ret === null ? undefined : ret; + } + }); + }); +} + +if ( !jQuery.support.style ) { + jQuery.attrHooks.style = { + get: function( elem ) { + // Return undefined in the case of empty string + // Normalize to lowercase since IE uppercases css property names + return elem.style.cssText.toLowerCase() || undefined; + }, + set: function( elem, value ) { + return ( elem.style.cssText = "" + value ); + } + }; +} + +// Safari mis-reports the default selected property of an option +// Accessing the parent's selectedIndex property fixes it +if ( !jQuery.support.optSelected ) { + jQuery.propHooks.selected = jQuery.extend( jQuery.propHooks.selected, { + get: function( elem ) { + var parent = elem.parentNode; + + if ( parent ) { + parent.selectedIndex; + + // Make sure that it also works with optgroups, see #5701 + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + return null; + } + }); +} + +// IE6/7 call enctype encoding +if ( !jQuery.support.enctype ) { + jQuery.propFix.enctype = "encoding"; +} + +// Radios and checkboxes getter/setter +if ( !jQuery.support.checkOn ) { + jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + get: function( elem ) { + // Handle the case where in Webkit "" is returned instead of "on" if a value isn't specified + return elem.getAttribute("value") === null ? "on" : elem.value; + } + }; + }); +} +jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = jQuery.extend( jQuery.valHooks[ this ], { + set: function( elem, value ) { + if ( jQuery.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery(elem).val(), value ) >= 0 ); + } + } + }); +}); + + + + +var rnamespaces = /\.(.*)$/, + rformElems = /^(?:textarea|input|select)$/i, + rperiod = /\./g, + rspaces = / /g, + rescape = /[^\w\s.|`]/g, + rtypenamespace = /^([^\.]*)?(?:\.(.+))?$/, + rhoverHack = /\bhover(\.\S+)?/, + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|contextmenu)|click/, + rquickIs = /^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/, + quickParse = function( selector ) { + var quick = rquickIs.exec( selector ); + if ( quick ) { + // 0 1 2 3 + // [ _, tag, id, class ] + quick[1] = ( quick[1] || "" ).toLowerCase(); + quick[3] = quick[3] && new RegExp( "(?:^|\\s)" + quick[3] + "(?:\\s|$)" ); + } + return quick; + }, + quickIs = function( elem, m ) { + return ( + (!m[1] || elem.nodeName.toLowerCase() === m[1]) && + (!m[2] || elem.id === m[2]) && + (!m[3] || m[3].test( elem.className )) + ); + }, + hoverHack = function( events ) { + return jQuery.event.special.hover ? events : events.replace( rhoverHack, "mouseenter$1 mouseleave$1" ); + }; + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + add: function( elem, types, handler, data, selector ) { + + var elemData, eventHandle, events, + t, tns, type, namespaces, handleObj, + handleObjIn, quick, handlers, special; + + // Don't attach events to noData or text/comment nodes (allow plain objects tho) + if ( elem.nodeType === 3 || elem.nodeType === 8 || !types || !handler || !(elemData = jQuery._data( elem )) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + events = elemData.events; + if ( !events ) { + elemData.events = events = {}; + } + eventHandle = elemData.handle; + if ( !eventHandle ) { + elemData.handle = eventHandle = function( e ) { + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && (!e || jQuery.event.triggered !== e.type) ? + jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : + undefined; + }; + // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events + eventHandle.elem = elem; + } + + // Handle multiple events separated by a space + // jQuery(...).bind("mouseover mouseout", fn); + types = hoverHack(types).split( " " ); + for ( t = 0; t < types.length; t++ ) { + + tns = rtypenamespace.exec( types[t] ) || []; + type = tns[1]; + namespaces = ( tns[2] || "" ).split( "." ).sort(); + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend({ + type: type, + origType: tns[1], + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + namespace: namespaces.join(".") + }, handleObjIn ); + + // Delegated event; pre-analyze selector so it's processed quickly on event dispatch + if ( selector ) { + handleObj.quick = quickParse( selector ); + if ( !handleObj.quick && jQuery.expr.match.POS.test( selector ) ) { + handleObj.isPositional = true; + } + } + + // Init the event handler queue if we're the first + handlers = events[ type ]; + if ( !handlers ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener/attachEvent if the special events handler returns false + if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + // Bind the global event handler to the element + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle, false ); + + } else if ( elem.attachEvent ) { + elem.attachEvent( "on" + type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + // Nullify elem to prevent memory leaks in IE + elem = null; + }, + + global: {}, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector ) { + + var elemData = jQuery.hasData( elem ) && jQuery._data( elem ), + t, tns, type, namespaces, origCount, + j, events, special, handle, eventType, handleObj; + + if ( !elemData || !(events = elemData.events) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = hoverHack( types || "" ).split(" "); + for ( t = 0; t < types.length; t++ ) { + tns = rtypenamespace.exec( types[t] ) || []; + type = tns[1]; + namespaces = tns[2]; + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + namespaces = namespaces? "." + namespaces : ""; + for ( j in events ) { + jQuery.event.remove( elem, j + namespaces, handler, selector ); + } + return; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector? special.delegateType : special.bindType ) || type; + eventType = events[ type ] || []; + origCount = eventType.length; + namespaces = namespaces ? new RegExp("(^|\\.)" + namespaces.split(".").sort().join("\\.(?:.*\\.)?") + "(\\.|$)") : null; + + // Only need to loop for special events or selective removal + if ( handler || namespaces || selector || special.remove ) { + for ( j = 0; j < eventType.length; j++ ) { + handleObj = eventType[ j ]; + + if ( !handler || handler.guid === handleObj.guid ) { + if ( !namespaces || namespaces.test( handleObj.namespace ) ) { + if ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) { + eventType.splice( j--, 1 ); + + if ( handleObj.selector ) { + eventType.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + } + } + } else { + // Removing all events + eventType.length = 0; + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( eventType.length === 0 && origCount !== eventType.length ) { + if ( !special.teardown || special.teardown.call( elem, namespaces ) === false ) { + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + handle = elemData.handle; + if ( handle ) { + handle.elem = null; + } + + // removeData also checks for emptiness and clears the expando if empty + // so use it instead of delete + jQuery.removeData( elem, [ "events", "handle" ], true ); + } + }, + + // Events that are safe to short-circuit if no handlers are attached. + // Native DOM events should not be added, they may have inline handlers. + customEvent: { + "getData": true, + "setData": true, + "changeData": true + }, + + trigger: function( event, data, elem, onlyHandlers ) { + // Don't do events on text and comment nodes + if ( elem && (elem.nodeType === 3 || elem.nodeType === 8) ) { + return; + } + + // Event object or event type + var type = event.type || event, + namespaces = [], + cache, exclusive, i, cur, old, ontype, special, handle, eventPath, bubbleType; + + if ( type.indexOf( "!" ) >= 0 ) { + // Exclusive events trigger only for the exact event (no namespaces) + type = type.slice(0, -1); + exclusive = true; + } + + if ( type.indexOf( "." ) >= 0 ) { + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split("."); + type = namespaces.shift(); + namespaces.sort(); + } + + if ( (!elem || jQuery.event.customEvent[ type ]) && !jQuery.event.global[ type ] ) { + // No jQuery handlers for this event type, and it can't have inline handlers + return; + } + + // Caller can pass in an Event, Object, or just an event type string + event = typeof event === "object" ? + // jQuery.Event object + event[ jQuery.expando ] ? event : + // Object literal + new jQuery.Event( type, event ) : + // Just the event type (string) + new jQuery.Event( type ); + + event.type = type; + event.isTrigger = true; + event.exclusive = exclusive; + event.namespace = namespaces.join( "." ); + event.namespace_re = event.namespace? new RegExp("(^|\\.)" + namespaces.join("\\.(?:.*\\.)?") + "(\\.|$)") : null; + ontype = type.indexOf( ":" ) < 0 ? "on" + type : ""; + + // triggerHandler() and global events don't bubble or run the default action + if ( onlyHandlers || !elem ) { + event.preventDefault(); + } + + // Handle a global trigger + if ( !elem ) { + + // TODO: Stop taunting the data cache; remove global events and always attach to document + cache = jQuery.cache; + for ( i in cache ) { + if ( cache[ i ].events && cache[ i ].events[ type ] ) { + jQuery.event.trigger( event, data, cache[ i ].handle.elem, true ); + } + } + return; + } + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data != null ? jQuery.makeArray( data ) : []; + data.unshift( event ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + eventPath = [[ elem, special.bindType || type ]]; + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + old = null; + for ( cur = elem.parentNode; cur; cur = cur.parentNode ) { + eventPath.push([ cur, bubbleType ]); + old = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( old && old === elem.ownerDocument ) { + eventPath.push([ old.defaultView || old.parentWindow || window, bubbleType ]); + } + } + + // Fire handlers on the event path + for ( i = 0; i < eventPath.length; i++ ) { + + cur = eventPath[i][0]; + event.type = eventPath[i][1]; + + handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + handle = ontype && cur[ ontype ]; + if ( handle && jQuery.acceptData( cur ) ) { + handle.apply( cur, data ); + } + + if ( event.isPropagationStopped() ) { + break; + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !event.isDefaultPrevented() ) { + + if ( (!special._default || special._default.apply( elem.ownerDocument, data ) === false) && + !(type === "click" && jQuery.nodeName( elem, "a" )) && jQuery.acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name name as the event. + // Can't use an .isFunction() check here because IE6/7 fails that test. + // Don't do default actions on window, that's where global variables be (#6170) + // IE<9 dies on focus/blur to hidden element (#1486) + if ( ontype && elem[ type ] && ((type !== "focus" && type !== "blur") || event.target.offsetWidth !== 0) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + old = elem[ ontype ]; + + if ( old ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( old ) { + elem[ ontype ] = old; + } + } + } + } + + return event.result; + }, + + dispatch: function( event ) { + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( event || window.event ); + + var handlers = ( (jQuery._data( this, "events" ) || {} )[ event.type ] || []), + delegateCount = handlers.delegateCount, + args = [].slice.call( arguments, 0 ), + run_all = !event.exclusive && !event.namespace, + specialHandle = ( jQuery.event.special[ event.type ] || {} ).handle, + handlerQueue = [], + i, j, cur, ret, selMatch, matched, matches, handleObj, sel, hit, related; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[0] = event; + event.delegateTarget = this; + + // Determine handlers that should run if there are delegated events + // Avoid disabled elements in IE (#6911) and non-left-click bubbling in Firefox (#3861) + if ( delegateCount && !event.target.disabled && !(event.button && event.type === "click") ) { + + for ( cur = event.target; cur != this; cur = cur.parentNode || this ) { + selMatch = {}; + matches = []; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + sel = handleObj.selector; + hit = selMatch[ sel ]; + + if ( handleObj.isPositional ) { + // Since .is() does not work for positionals; see http://jsfiddle.net/eJ4yd/3/ + hit = ( hit || (selMatch[ sel ] = jQuery( sel )) ).index( cur ) >= 0; + } else if ( hit === undefined ) { + hit = selMatch[ sel ] = ( handleObj.quick ? quickIs( cur, handleObj.quick ) : jQuery( cur ).is( sel ) ); + } + if ( hit ) { + matches.push( handleObj ); + } + } + if ( matches.length ) { + handlerQueue.push({ elem: cur, matches: matches }); + } + } + } + + // Add the remaining (directly-bound) handlers + if ( handlers.length > delegateCount ) { + handlerQueue.push({ elem: this, matches: handlers.slice( delegateCount ) }); + } + + // Run delegates first; they may want to stop propagation beneath us + for ( i = 0; i < handlerQueue.length && !event.isPropagationStopped(); i++ ) { + matched = handlerQueue[ i ]; + event.currentTarget = matched.elem; + + for ( j = 0; j < matched.matches.length && !event.isImmediatePropagationStopped(); j++ ) { + handleObj = matched.matches[ j ]; + + // Triggered event must either 1) be non-exclusive and have no namespace, or + // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). + if ( run_all || (!event.namespace && !handleObj.namespace) || event.namespace_re && event.namespace_re.test( handleObj.namespace ) ) { + + event.data = handleObj.data; + event.handleObj = handleObj; + + ret = ( specialHandle || handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + event.result = ret; + if ( ret === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + return event.result; + }, + + // Includes some event props shared by KeyEvent and MouseEvent + // *** attrChange attrName relatedNode srcElement are not normalized, non-W3C, deprecated, will be removed in 1.8 *** + props: "attrChange attrName relatedNode srcElement altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), + + fixHooks: {}, + + keyHooks: { + props: "char charCode key keyCode".split(" "), + filter: function( event, original ) { + + // Add which for key events + if ( event.which == null ) { + event.which = original.charCode != null ? original.charCode : original.keyCode; + } + + return event; + } + }, + + mouseHooks: { + props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement wheelDelta".split(" "), + filter: function( event, original ) { + var eventDoc, doc, body, + button = original.button, + fromElement = original.fromElement; + + // Calculate pageX/Y if missing and clientX/Y available + if ( event.pageX == null && original.clientX != null ) { + eventDoc = event.target.ownerDocument || document; + doc = eventDoc.documentElement; + body = eventDoc.body; + + event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); + event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); + } + + // Add relatedTarget, if necessary + if ( !event.relatedTarget && fromElement ) { + event.relatedTarget = fromElement === event.target ? original.toElement : fromElement; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + // Note: button is not normalized, so don't use it + if ( !event.which && button !== undefined ) { + event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); + } + + return event; + } + }, + + fix: function( event ) { + if ( event[ jQuery.expando ] ) { + return event; + } + + // Create a writable copy of the event object and normalize some properties + var i, prop, + originalEvent = event, + fixHook = jQuery.event.fixHooks[ event.type ] || {}, + copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; + + event = jQuery.Event( originalEvent ); + + for ( i = copy.length; i; ) { + prop = copy[ --i ]; + event[ prop ] = originalEvent[ prop ]; + } + + // Fix target property, if necessary (#1925, IE 6/7/8 & Safari2) + if ( !event.target ) { + event.target = originalEvent.srcElement || document; + } + + // Target should not be a text node (#504, Safari) + if ( event.target.nodeType === 3 ) { + event.target = event.target.parentNode; + } + + // For mouse/key events; add metaKey if it's not there (#3368, IE6/7/8) + if ( event.metaKey === undefined ) { + event.metaKey = event.ctrlKey; + } + + return fixHook.filter? fixHook.filter( event, originalEvent ) : event; + }, + + special: { + ready: { + // Make sure the ready event is setup + setup: jQuery.bindReady + }, + + focus: { + delegateType: "focusin", + noBubble: true + }, + blur: { + delegateType: "focusout", + noBubble: true + }, + + beforeunload: { + setup: function( data, namespaces, eventHandle ) { + // We only want to do this special case on windows + if ( jQuery.isWindow( this ) ) { + this.onbeforeunload = eventHandle; + } + }, + + teardown: function( namespaces, eventHandle ) { + if ( this.onbeforeunload === eventHandle ) { + this.onbeforeunload = null; + } + } + } + }, + + simulate: function( type, elem, event, bubble ) { + // Piggyback on a donor event to simulate a different one. + // Fake originalEvent to avoid donor's stopPropagation, but if the + // simulated event prevents default then we do the same on the donor. + var e = jQuery.extend( + new jQuery.Event(), + event, + { type: type, + isSimulated: true, + originalEvent: {} + } + ); + if ( bubble ) { + jQuery.event.trigger( e, null, elem ); + } else { + jQuery.event.dispatch.call( elem, e ); + } + if ( e.isDefaultPrevented() ) { + event.preventDefault(); + } + } +}; + +// Some plugins are using, but it's undocumented/deprecated and will be removed. +// The 1.7 special event interface should provide all the hooks needed now. +jQuery.event.handle = jQuery.event.dispatch; + +jQuery.removeEvent = document.removeEventListener ? + function( elem, type, handle ) { + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle, false ); + } + } : + function( elem, type, handle ) { + if ( elem.detachEvent ) { + elem.detachEvent( "on" + type, handle ); + } + }; + +jQuery.Event = function( src, props ) { + // Allow instantiation without the 'new' keyword + if ( !(this instanceof jQuery.Event) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = ( src.defaultPrevented || src.returnValue === false || + src.getPreventDefault && src.getPreventDefault() ) ? returnTrue : returnFalse; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +function returnFalse() { + return false; +} +function returnTrue() { + return true; +} + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + preventDefault: function() { + this.isDefaultPrevented = returnTrue; + + var e = this.originalEvent; + if ( !e ) { + return; + } + + // if preventDefault exists run it on the original event + if ( e.preventDefault ) { + e.preventDefault(); + + // otherwise set the returnValue property of the original event to false (IE) + } else { + e.returnValue = false; + } + }, + stopPropagation: function() { + this.isPropagationStopped = returnTrue; + + var e = this.originalEvent; + if ( !e ) { + return; + } + // if stopPropagation exists run it on the original event + if ( e.stopPropagation ) { + e.stopPropagation(); + } + // otherwise set the cancelBubble property of the original event to true (IE) + e.cancelBubble = true; + }, + stopImmediatePropagation: function() { + this.isImmediatePropagationStopped = returnTrue; + this.stopPropagation(); + }, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse +}; + +// Create mouseenter/leave events using mouseover/out and event-time checks +jQuery.each({ + mouseenter: "mouseover", + mouseleave: "mouseout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = jQuery.event.special[ fix ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var target = this, + related = event.relatedTarget, + handleObj = event.handleObj, + selector = handleObj.selector, + oldType, ret; + + // For a real mouseover/out, always call the handler; for + // mousenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || handleObj.origType === event.type || (related !== target && !jQuery.contains( target, related )) ) { + oldType = event.type; + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = oldType; + } + return ret; + } + }; +}); + +// IE submit delegation +if ( !jQuery.support.submitBubbles ) { + + jQuery.event.special.submit = { + setup: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Lazy-add a submit handler when a descendant form may potentially be submitted + jQuery.event.add( this, "click._submit keypress._submit", function( e ) { + // Node name check avoids a VML-related crash in IE (#9807) + var elem = e.target, + form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined; + if ( form && !form._submit_attached ) { + jQuery.event.add( form, "submit._submit", function( event ) { + // Form was submitted, bubble the event up the tree + if ( this.parentNode ) { + jQuery.event.simulate( "submit", this.parentNode, event, true ); + } + }); + form._submit_attached = true; + } + }); + // return undefined since we don't need an event listener + }, + + teardown: function() { + // Only need this for delegated form submit events + if ( jQuery.nodeName( this, "form" ) ) { + return false; + } + + // Remove delegated handlers; cleanData eventually reaps submit handlers attached above + jQuery.event.remove( this, "._submit" ); + } + }; +} + +// IE change delegation and checkbox/radio fix +if ( !jQuery.support.changeBubbles ) { + + jQuery.event.special.change = { + + setup: function() { + + if ( rformElems.test( this.nodeName ) ) { + // IE doesn't fire change on a check/radio until blur; trigger it on click + // after a propertychange. Eat the blur-change in special.change.handle. + // This still fires onchange a second time for check/radio after blur. + if ( this.type === "checkbox" || this.type === "radio" ) { + jQuery.event.add( this, "propertychange._change", function( event ) { + if ( event.originalEvent.propertyName === "checked" ) { + this._just_changed = true; + } + }); + jQuery.event.add( this, "click._change", function( event ) { + if ( this._just_changed ) { + this._just_changed = false; + jQuery.event.simulate( "change", this, event, true ); + } + }); + } + return false; + } + // Delegated event; lazy-add a change handler on descendant inputs + jQuery.event.add( this, "beforeactivate._change", function( e ) { + var elem = e.target; + + if ( rformElems.test( elem.nodeName ) && !elem._change_attached ) { + jQuery.event.add( elem, "change._change", function( event ) { + if ( this.parentNode && !event.isSimulated ) { + jQuery.event.simulate( "change", this.parentNode, event, true ); + } + }); + elem._change_attached = true; + } + }); + }, + + handle: function( event ) { + var elem = event.target; + + // Swallow native change events from checkbox/radio, we already triggered them above + if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) { + return event.handleObj.handler.apply( this, arguments ); + } + }, + + teardown: function() { + jQuery.event.remove( this, "._change" ); + + return rformElems.test( this.nodeName ); + } + }; +} + +// Create "bubbling" focus and blur events +if ( !jQuery.support.focusinBubbles ) { + jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler while someone wants focusin/focusout + var attaches = 0, + handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + if ( attaches++ === 0 ) { + document.addEventListener( orig, handler, true ); + } + }, + teardown: function() { + if ( --attaches === 0 ) { + document.removeEventListener( orig, handler, true ); + } + } + }; + }); +} + +jQuery.fn.extend({ + + on: function( types, selector, data, fn, /*INTERNAL*/ one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + // ( types-Object, data ) + data = selector; + selector = undefined; + } + for ( type in types ) { + this.on( type, selector, data, types[ type ], one ); + } + return this; + } + + if ( data == null && fn == null ) { + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return this; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return this.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + }); + }, + one: function( types, selector, data, fn ) { + return this.on.call( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + if ( types && types.preventDefault && types.handleObj ) { + // ( event ) dispatched jQuery.Event + var handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace? handleObj.type + "." + handleObj.namespace : handleObj.type, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + // ( types-object [, selector] ) + for ( var type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each(function() { + jQuery.event.remove( this, types, fn, selector ); + }); + }, + + bind: function( types, data, fn ) { + return this.on( types, null, data, fn ); + }, + unbind: function( types, fn ) { + return this.off( types, null, fn ); + }, + + live: function( types, data, fn ) { + jQuery( this.context ).on( types, this.selector, data, fn ); + return this; + }, + die: function( types, fn ) { + jQuery( this.context ).off( types, this.selector || "**", fn ); + return this; + }, + + delegate: function( selector, types, data, fn ) { + return this.on( types, selector, data, fn ); + }, + undelegate: function( selector, types, fn ) { + // ( namespace ) or ( selector, types [, fn] ) + return arguments.length == 1? this.off( selector, "**" ) : this.off( types, selector, fn ); + }, + + trigger: function( type, data ) { + return this.each(function() { + jQuery.event.trigger( type, data, this ); + }); + }, + triggerHandler: function( type, data ) { + if ( this[0] ) { + return jQuery.event.trigger( type, data, this[0], true ); + } + }, + + toggle: function( fn ) { + // Save reference to arguments for access in closure + var args = arguments, + guid = fn.guid || jQuery.guid++, + i = 0, + toggler = function( event ) { + // Figure out which function to execute + var lastToggle = ( jQuery._data( this, "lastToggle" + fn.guid ) || 0 ) % i; + jQuery._data( this, "lastToggle" + fn.guid, lastToggle + 1 ); + + // Make sure that clicks stop + event.preventDefault(); + + // and execute the function + return args[ lastToggle ].apply( this, arguments ) || false; + }; + + // link all the functions, so any of them can unbind this click handler + toggler.guid = guid; + while ( i < args.length ) { + args[ i++ ].guid = guid; + } + + return this.click( toggler ); + }, + + hover: function( fnOver, fnOut ) { + return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); + } +}); + +jQuery.each( ("blur focus focusin focusout load resize scroll unload click dblclick " + + "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + + "change select submit keydown keypress keyup error contextmenu").split(" "), function( i, name ) { + + // Handle event binding + jQuery.fn[ name ] = function( data, fn ) { + if ( fn == null ) { + fn = data; + data = null; + } + + return arguments.length > 0 ? + this.bind( name, data, fn ) : + this.trigger( name ); + }; + + if ( jQuery.attrFn ) { + jQuery.attrFn[ name ] = true; + } + + if ( rkeyEvent.test( name ) ) { + jQuery.event.fixHooks[ name ] = jQuery.event.keyHooks; + } + + if ( rmouseEvent.test( name ) ) { + jQuery.event.fixHooks[ name ] = jQuery.event.mouseHooks; + } +}); + + + +/*! + * Sizzle CSS Selector Engine + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){ + +var chunker = /((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, + expando = "sizcache" + (Math.random() + '').replace('.', ''), + done = 0, + toString = Object.prototype.toString, + hasDuplicate = false, + baseHasDuplicate = true, + rBackslash = /\\/g, + rReturn = /\r\n/g, + rNonWord = /\W/; + +// Here we check if the JavaScript engine is using some sort of +// optimization where it does not always call our comparision +// function. If that is the case, discard the hasDuplicate value. +// Thus far that includes Google Chrome. +[0, 0].sort(function() { + baseHasDuplicate = false; + return 0; +}); + +var Sizzle = function( selector, context, results, seed ) { + results = results || []; + context = context || document; + + var origContext = context; + + if ( context.nodeType !== 1 && context.nodeType !== 9 ) { + return []; + } + + if ( !selector || typeof selector !== "string" ) { + return results; + } + + var m, set, checkSet, extra, ret, cur, pop, i, + prune = true, + contextXML = Sizzle.isXML( context ), + parts = [], + soFar = selector; + + // Reset the position of the chunker regexp (start from head) + do { + chunker.exec( "" ); + m = chunker.exec( soFar ); + + if ( m ) { + soFar = m[3]; + + parts.push( m[1] ); + + if ( m[2] ) { + extra = m[3]; + break; + } + } + } while ( m ); + + if ( parts.length > 1 && origPOS.exec( selector ) ) { + + if ( parts.length === 2 && Expr.relative[ parts[0] ] ) { + set = posProcess( parts[0] + parts[1], context, seed ); + + } else { + set = Expr.relative[ parts[0] ] ? + [ context ] : + Sizzle( parts.shift(), context ); + + while ( parts.length ) { + selector = parts.shift(); + + if ( Expr.relative[ selector ] ) { + selector += parts.shift(); + } + + set = posProcess( selector, set, seed ); + } + } + + } else { + // Take a shortcut and set the context if the root selector is an ID + // (but not if it'll be faster if the inner selector is an ID) + if ( !seed && parts.length > 1 && context.nodeType === 9 && !contextXML && + Expr.match.ID.test(parts[0]) && !Expr.match.ID.test(parts[parts.length - 1]) ) { + + ret = Sizzle.find( parts.shift(), context, contextXML ); + context = ret.expr ? + Sizzle.filter( ret.expr, ret.set )[0] : + ret.set[0]; + } + + if ( context ) { + ret = seed ? + { expr: parts.pop(), set: makeArray(seed) } : + Sizzle.find( parts.pop(), parts.length === 1 && (parts[0] === "~" || parts[0] === "+") && context.parentNode ? context.parentNode : context, contextXML ); + + set = ret.expr ? + Sizzle.filter( ret.expr, ret.set ) : + ret.set; + + if ( parts.length > 0 ) { + checkSet = makeArray( set ); + + } else { + prune = false; + } + + while ( parts.length ) { + cur = parts.pop(); + pop = cur; + + if ( !Expr.relative[ cur ] ) { + cur = ""; + } else { + pop = parts.pop(); + } + + if ( pop == null ) { + pop = context; + } + + Expr.relative[ cur ]( checkSet, pop, contextXML ); + } + + } else { + checkSet = parts = []; + } + } + + if ( !checkSet ) { + checkSet = set; + } + + if ( !checkSet ) { + Sizzle.error( cur || selector ); + } + + if ( toString.call(checkSet) === "[object Array]" ) { + if ( !prune ) { + results.push.apply( results, checkSet ); + + } else if ( context && context.nodeType === 1 ) { + for ( i = 0; checkSet[i] != null; i++ ) { + if ( checkSet[i] && (checkSet[i] === true || checkSet[i].nodeType === 1 && Sizzle.contains(context, checkSet[i])) ) { + results.push( set[i] ); + } + } + + } else { + for ( i = 0; checkSet[i] != null; i++ ) { + if ( checkSet[i] && checkSet[i].nodeType === 1 ) { + results.push( set[i] ); + } + } + } + + } else { + makeArray( checkSet, results ); + } + + if ( extra ) { + Sizzle( extra, origContext, results, seed ); + Sizzle.uniqueSort( results ); + } + + return results; +}; + +Sizzle.uniqueSort = function( results ) { + if ( sortOrder ) { + hasDuplicate = baseHasDuplicate; + results.sort( sortOrder ); + + if ( hasDuplicate ) { + for ( var i = 1; i < results.length; i++ ) { + if ( results[i] === results[ i - 1 ] ) { + results.splice( i--, 1 ); + } + } + } + } + + return results; +}; + +Sizzle.matches = function( expr, set ) { + return Sizzle( expr, null, null, set ); +}; + +Sizzle.matchesSelector = function( node, expr ) { + return Sizzle( expr, null, null, [node] ).length > 0; +}; + +Sizzle.find = function( expr, context, isXML ) { + var set, i, len, match, type, left; + + if ( !expr ) { + return []; + } + + for ( i = 0, len = Expr.order.length; i < len; i++ ) { + type = Expr.order[i]; + + if ( (match = Expr.leftMatch[ type ].exec( expr )) ) { + left = match[1]; + match.splice( 1, 1 ); + + if ( left.substr( left.length - 1 ) !== "\\" ) { + match[1] = (match[1] || "").replace( rBackslash, "" ); + set = Expr.find[ type ]( match, context, isXML ); + + if ( set != null ) { + expr = expr.replace( Expr.match[ type ], "" ); + break; + } + } + } + } + + if ( !set ) { + set = typeof context.getElementsByTagName !== "undefined" ? + context.getElementsByTagName( "*" ) : + []; + } + + return { set: set, expr: expr }; +}; + +Sizzle.filter = function( expr, set, inplace, not ) { + var match, anyFound, + type, found, item, filter, left, + i, pass, + old = expr, + result = [], + curLoop = set, + isXMLFilter = set && set[0] && Sizzle.isXML( set[0] ); + + while ( expr && set.length ) { + for ( type in Expr.filter ) { + if ( (match = Expr.leftMatch[ type ].exec( expr )) != null && match[2] ) { + filter = Expr.filter[ type ]; + left = match[1]; + + anyFound = false; + + match.splice(1,1); + + if ( left.substr( left.length - 1 ) === "\\" ) { + continue; + } + + if ( curLoop === result ) { + result = []; + } + + if ( Expr.preFilter[ type ] ) { + match = Expr.preFilter[ type ]( match, curLoop, inplace, result, not, isXMLFilter ); + + if ( !match ) { + anyFound = found = true; + + } else if ( match === true ) { + continue; + } + } + + if ( match ) { + for ( i = 0; (item = curLoop[i]) != null; i++ ) { + if ( item ) { + found = filter( item, match, i, curLoop ); + pass = not ^ found; + + if ( inplace && found != null ) { + if ( pass ) { + anyFound = true; + + } else { + curLoop[i] = false; + } + + } else if ( pass ) { + result.push( item ); + anyFound = true; + } + } + } + } + + if ( found !== undefined ) { + if ( !inplace ) { + curLoop = result; + } + + expr = expr.replace( Expr.match[ type ], "" ); + + if ( !anyFound ) { + return []; + } + + break; + } + } + } + + // Improper expression + if ( expr === old ) { + if ( anyFound == null ) { + Sizzle.error( expr ); + + } else { + break; + } + } + + old = expr; + } + + return curLoop; +}; + +Sizzle.error = function( msg ) { + throw "Syntax error, unrecognized expression: " + msg; +}; + +/** + * Utility function for retreiving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +var getText = Sizzle.getText = function( elem ) { + var i, node, + nodeType = elem.nodeType, + ret = ""; + + if ( nodeType ) { + if ( nodeType === 1 ) { + // Use textContent || innerText for elements + if ( typeof elem.textContent === 'string' ) { + return elem.textContent; + } else if ( typeof elem.innerText === 'string' ) { + // Replace IE's carriage returns + return elem.innerText.replace( rReturn, '' ); + } else { + // Traverse it's children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + } else { + + // If no nodeType, this is expected to be an array + for ( i = 0; (node = elem[i]); i++ ) { + // Do not traverse comment nodes + if ( node.nodeType !== 8 ) { + ret += getText( node ); + } + } + } + return ret; +}; + +var Expr = Sizzle.selectors = { + order: [ "ID", "NAME", "TAG" ], + + match: { + ID: /#((?:[\w\u00c0-\uFFFF\-]|\\.)+)/, + CLASS: /\.((?:[\w\u00c0-\uFFFF\-]|\\.)+)/, + NAME: /\[name=['"]*((?:[\w\u00c0-\uFFFF\-]|\\.)+)['"]*\]/, + ATTR: /\[\s*((?:[\w\u00c0-\uFFFF\-]|\\.)+)\s*(?:(\S?=)\s*(?:(['"])(.*?)\3|(#?(?:[\w\u00c0-\uFFFF\-]|\\.)*)|)|)\s*\]/, + TAG: /^((?:[\w\u00c0-\uFFFF\*\-]|\\.)+)/, + CHILD: /:(only|nth|last|first)-child(?:\(\s*(even|odd|(?:[+\-]?\d+|(?:[+\-]?\d*)?n\s*(?:[+\-]\s*\d+)?))\s*\))?/, + POS: /:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^\-]|$)/, + PSEUDO: /:((?:[\w\u00c0-\uFFFF\-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/ + }, + + leftMatch: {}, + + attrMap: { + "class": "className", + "for": "htmlFor" + }, + + attrHandle: { + href: function( elem ) { + return elem.getAttribute( "href" ); + }, + type: function( elem ) { + return elem.getAttribute( "type" ); + } + }, + + relative: { + "+": function(checkSet, part){ + var isPartStr = typeof part === "string", + isTag = isPartStr && !rNonWord.test( part ), + isPartStrNotTag = isPartStr && !isTag; + + if ( isTag ) { + part = part.toLowerCase(); + } + + for ( var i = 0, l = checkSet.length, elem; i < l; i++ ) { + if ( (elem = checkSet[i]) ) { + while ( (elem = elem.previousSibling) && elem.nodeType !== 1 ) {} + + checkSet[i] = isPartStrNotTag || elem && elem.nodeName.toLowerCase() === part ? + elem || false : + elem === part; + } + } + + if ( isPartStrNotTag ) { + Sizzle.filter( part, checkSet, true ); + } + }, + + ">": function( checkSet, part ) { + var elem, + isPartStr = typeof part === "string", + i = 0, + l = checkSet.length; + + if ( isPartStr && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + + for ( ; i < l; i++ ) { + elem = checkSet[i]; + + if ( elem ) { + var parent = elem.parentNode; + checkSet[i] = parent.nodeName.toLowerCase() === part ? parent : false; + } + } + + } else { + for ( ; i < l; i++ ) { + elem = checkSet[i]; + + if ( elem ) { + checkSet[i] = isPartStr ? + elem.parentNode : + elem.parentNode === part; + } + } + + if ( isPartStr ) { + Sizzle.filter( part, checkSet, true ); + } + } + }, + + "": function(checkSet, part, isXML){ + var nodeCheck, + doneName = done++, + checkFn = dirCheck; + + if ( typeof part === "string" && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + nodeCheck = part; + checkFn = dirNodeCheck; + } + + checkFn( "parentNode", part, doneName, checkSet, nodeCheck, isXML ); + }, + + "~": function( checkSet, part, isXML ) { + var nodeCheck, + doneName = done++, + checkFn = dirCheck; + + if ( typeof part === "string" && !rNonWord.test( part ) ) { + part = part.toLowerCase(); + nodeCheck = part; + checkFn = dirNodeCheck; + } + + checkFn( "previousSibling", part, doneName, checkSet, nodeCheck, isXML ); + } + }, + + find: { + ID: function( match, context, isXML ) { + if ( typeof context.getElementById !== "undefined" && !isXML ) { + var m = context.getElementById(match[1]); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + return m && m.parentNode ? [m] : []; + } + }, + + NAME: function( match, context ) { + if ( typeof context.getElementsByName !== "undefined" ) { + var ret = [], + results = context.getElementsByName( match[1] ); + + for ( var i = 0, l = results.length; i < l; i++ ) { + if ( results[i].getAttribute("name") === match[1] ) { + ret.push( results[i] ); + } + } + + return ret.length === 0 ? null : ret; + } + }, + + TAG: function( match, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( match[1] ); + } + } + }, + preFilter: { + CLASS: function( match, curLoop, inplace, result, not, isXML ) { + match = " " + match[1].replace( rBackslash, "" ) + " "; + + if ( isXML ) { + return match; + } + + for ( var i = 0, elem; (elem = curLoop[i]) != null; i++ ) { + if ( elem ) { + if ( not ^ (elem.className && (" " + elem.className + " ").replace(/[\t\n\r]/g, " ").indexOf(match) >= 0) ) { + if ( !inplace ) { + result.push( elem ); + } + + } else if ( inplace ) { + curLoop[i] = false; + } + } + } + + return false; + }, + + ID: function( match ) { + return match[1].replace( rBackslash, "" ); + }, + + TAG: function( match, curLoop ) { + return match[1].replace( rBackslash, "" ).toLowerCase(); + }, + + CHILD: function( match ) { + if ( match[1] === "nth" ) { + if ( !match[2] ) { + Sizzle.error( match[0] ); + } + + match[2] = match[2].replace(/^\+|\s*/g, ''); + + // parse equations like 'even', 'odd', '5', '2n', '3n+2', '4n-1', '-n+6' + var test = /(-?)(\d*)(?:n([+\-]?\d*))?/.exec( + match[2] === "even" && "2n" || match[2] === "odd" && "2n+1" || + !/\D/.test( match[2] ) && "0n+" + match[2] || match[2]); + + // calculate the numbers (first)n+(last) including if they are negative + match[2] = (test[1] + (test[2] || 1)) - 0; + match[3] = test[3] - 0; + } + else if ( match[2] ) { + Sizzle.error( match[0] ); + } + + // TODO: Move to normal caching system + match[0] = done++; + + return match; + }, + + ATTR: function( match, curLoop, inplace, result, not, isXML ) { + var name = match[1] = match[1].replace( rBackslash, "" ); + + if ( !isXML && Expr.attrMap[name] ) { + match[1] = Expr.attrMap[name]; + } + + // Handle if an un-quoted value was used + match[4] = ( match[4] || match[5] || "" ).replace( rBackslash, "" ); + + if ( match[2] === "~=" ) { + match[4] = " " + match[4] + " "; + } + + return match; + }, + + PSEUDO: function( match, curLoop, inplace, result, not ) { + if ( match[1] === "not" ) { + // If we're dealing with a complex expression, or a simple one + if ( ( chunker.exec(match[3]) || "" ).length > 1 || /^\w/.test(match[3]) ) { + match[3] = Sizzle(match[3], null, null, curLoop); + + } else { + var ret = Sizzle.filter(match[3], curLoop, inplace, true ^ not); + + if ( !inplace ) { + result.push.apply( result, ret ); + } + + return false; + } + + } else if ( Expr.match.POS.test( match[0] ) || Expr.match.CHILD.test( match[0] ) ) { + return true; + } + + return match; + }, + + POS: function( match ) { + match.unshift( true ); + + return match; + } + }, + + filters: { + enabled: function( elem ) { + return elem.disabled === false && elem.type !== "hidden"; + }, + + disabled: function( elem ) { + return elem.disabled === true; + }, + + checked: function( elem ) { + return elem.checked === true; + }, + + selected: function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + parent: function( elem ) { + return !!elem.firstChild; + }, + + empty: function( elem ) { + return !elem.firstChild; + }, + + has: function( elem, i, match ) { + return !!Sizzle( match[3], elem ).length; + }, + + header: function( elem ) { + return (/h\d/i).test( elem.nodeName ); + }, + + text: function( elem ) { + var attr = elem.getAttribute( "type" ), type = elem.type; + // IE6 and 7 will map elem.type to 'text' for new HTML5 types (search, etc) + // use getAttribute instead to test this case + return elem.nodeName.toLowerCase() === "input" && "text" === type && ( attr === type || attr === null ); + }, + + radio: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "radio" === elem.type; + }, + + checkbox: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "checkbox" === elem.type; + }, + + file: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "file" === elem.type; + }, + + password: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "password" === elem.type; + }, + + submit: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && "submit" === elem.type; + }, + + image: function( elem ) { + return elem.nodeName.toLowerCase() === "input" && "image" === elem.type; + }, + + reset: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && "reset" === elem.type; + }, + + button: function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && "button" === elem.type || name === "button"; + }, + + input: function( elem ) { + return (/input|select|textarea|button/i).test( elem.nodeName ); + }, + + focus: function( elem ) { + return elem === elem.ownerDocument.activeElement; + } + }, + setFilters: { + first: function( elem, i ) { + return i === 0; + }, + + last: function( elem, i, match, array ) { + return i === array.length - 1; + }, + + even: function( elem, i ) { + return i % 2 === 0; + }, + + odd: function( elem, i ) { + return i % 2 === 1; + }, + + lt: function( elem, i, match ) { + return i < match[3] - 0; + }, + + gt: function( elem, i, match ) { + return i > match[3] - 0; + }, + + nth: function( elem, i, match ) { + return match[3] - 0 === i; + }, + + eq: function( elem, i, match ) { + return match[3] - 0 === i; + } + }, + filter: { + PSEUDO: function( elem, match, i, array ) { + var name = match[1], + filter = Expr.filters[ name ]; + + if ( filter ) { + return filter( elem, i, match, array ); + + } else if ( name === "contains" ) { + return (elem.textContent || elem.innerText || getText([ elem ]) || "").indexOf(match[3]) >= 0; + + } else if ( name === "not" ) { + var not = match[3]; + + for ( var j = 0, l = not.length; j < l; j++ ) { + if ( not[j] === elem ) { + return false; + } + } + + return true; + + } else { + Sizzle.error( name ); + } + }, + + CHILD: function( elem, match ) { + var first, last, + doneName, parent, cache, + count, diff, + type = match[1], + node = elem; + + switch ( type ) { + case "only": + case "first": + while ( (node = node.previousSibling) ) { + if ( node.nodeType === 1 ) { + return false; + } + } + + if ( type === "first" ) { + return true; + } + + node = elem; + + case "last": + while ( (node = node.nextSibling) ) { + if ( node.nodeType === 1 ) { + return false; + } + } + + return true; + + case "nth": + first = match[2]; + last = match[3]; + + if ( first === 1 && last === 0 ) { + return true; + } + + doneName = match[0]; + parent = elem.parentNode; + + if ( parent && (parent[ expando ] !== doneName || !elem.nodeIndex) ) { + count = 0; + + for ( node = parent.firstChild; node; node = node.nextSibling ) { + if ( node.nodeType === 1 ) { + node.nodeIndex = ++count; + } + } + + parent[ expando ] = doneName; + } + + diff = elem.nodeIndex - last; + + if ( first === 0 ) { + return diff === 0; + + } else { + return ( diff % first === 0 && diff / first >= 0 ); + } + } + }, + + ID: function( elem, match ) { + return elem.nodeType === 1 && elem.getAttribute("id") === match; + }, + + TAG: function( elem, match ) { + return (match === "*" && elem.nodeType === 1) || !!elem.nodeName && elem.nodeName.toLowerCase() === match; + }, + + CLASS: function( elem, match ) { + return (" " + (elem.className || elem.getAttribute("class")) + " ") + .indexOf( match ) > -1; + }, + + ATTR: function( elem, match ) { + var name = match[1], + result = Sizzle.attr ? + Sizzle.attr( elem, name ) : + Expr.attrHandle[ name ] ? + Expr.attrHandle[ name ]( elem ) : + elem[ name ] != null ? + elem[ name ] : + elem.getAttribute( name ), + value = result + "", + type = match[2], + check = match[4]; + + return result == null ? + type === "!=" : + !type && Sizzle.attr ? + result != null : + type === "=" ? + value === check : + type === "*=" ? + value.indexOf(check) >= 0 : + type === "~=" ? + (" " + value + " ").indexOf(check) >= 0 : + !check ? + value && result !== false : + type === "!=" ? + value !== check : + type === "^=" ? + value.indexOf(check) === 0 : + type === "$=" ? + value.substr(value.length - check.length) === check : + type === "|=" ? + value === check || value.substr(0, check.length + 1) === check + "-" : + false; + }, + + POS: function( elem, match, i, array ) { + var name = match[2], + filter = Expr.setFilters[ name ]; + + if ( filter ) { + return filter( elem, i, match, array ); + } + } + } +}; + +var origPOS = Expr.match.POS, + fescape = function(all, num){ + return "\\" + (num - 0 + 1); + }; + +for ( var type in Expr.match ) { + Expr.match[ type ] = new RegExp( Expr.match[ type ].source + (/(?![^\[]*\])(?![^\(]*\))/.source) ); + Expr.leftMatch[ type ] = new RegExp( /(^(?:.|\r|\n)*?)/.source + Expr.match[ type ].source.replace(/\\(\d+)/g, fescape) ); +} + +var makeArray = function( array, results ) { + array = Array.prototype.slice.call( array, 0 ); + + if ( results ) { + results.push.apply( results, array ); + return results; + } + + return array; +}; + +// Perform a simple check to determine if the browser is capable of +// converting a NodeList to an array using builtin methods. +// Also verifies that the returned array holds DOM nodes +// (which is not the case in the Blackberry browser) +try { + Array.prototype.slice.call( document.documentElement.childNodes, 0 )[0].nodeType; + +// Provide a fallback method if it does not work +} catch( e ) { + makeArray = function( array, results ) { + var i = 0, + ret = results || []; + + if ( toString.call(array) === "[object Array]" ) { + Array.prototype.push.apply( ret, array ); + + } else { + if ( typeof array.length === "number" ) { + for ( var l = array.length; i < l; i++ ) { + ret.push( array[i] ); + } + + } else { + for ( ; array[i]; i++ ) { + ret.push( array[i] ); + } + } + } + + return ret; + }; +} + +var sortOrder, siblingCheck; + +if ( document.documentElement.compareDocumentPosition ) { + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + if ( !a.compareDocumentPosition || !b.compareDocumentPosition ) { + return a.compareDocumentPosition ? -1 : 1; + } + + return a.compareDocumentPosition(b) & 4 ? -1 : 1; + }; + +} else { + sortOrder = function( a, b ) { + // The nodes are identical, we can exit early + if ( a === b ) { + hasDuplicate = true; + return 0; + + // Fallback to using sourceIndex (in IE) if it's available on both nodes + } else if ( a.sourceIndex && b.sourceIndex ) { + return a.sourceIndex - b.sourceIndex; + } + + var al, bl, + ap = [], + bp = [], + aup = a.parentNode, + bup = b.parentNode, + cur = aup; + + // If the nodes are siblings (or identical) we can do a quick check + if ( aup === bup ) { + return siblingCheck( a, b ); + + // If no parents were found then the nodes are disconnected + } else if ( !aup ) { + return -1; + + } else if ( !bup ) { + return 1; + } + + // Otherwise they're somewhere else in the tree so we need + // to build up a full list of the parentNodes for comparison + while ( cur ) { + ap.unshift( cur ); + cur = cur.parentNode; + } + + cur = bup; + + while ( cur ) { + bp.unshift( cur ); + cur = cur.parentNode; + } + + al = ap.length; + bl = bp.length; + + // Start walking down the tree looking for a discrepancy + for ( var i = 0; i < al && i < bl; i++ ) { + if ( ap[i] !== bp[i] ) { + return siblingCheck( ap[i], bp[i] ); + } + } + + // We ended someplace up the tree so do a sibling check + return i === al ? + siblingCheck( a, bp[i], -1 ) : + siblingCheck( ap[i], b, 1 ); + }; + + siblingCheck = function( a, b, ret ) { + if ( a === b ) { + return ret; + } + + var cur = a.nextSibling; + + while ( cur ) { + if ( cur === b ) { + return -1; + } + + cur = cur.nextSibling; + } + + return 1; + }; +} + +// Check to see if the browser returns elements by name when +// querying by getElementById (and provide a workaround) +(function(){ + // We're going to inject a fake input element with a specified name + var form = document.createElement("div"), + id = "script" + (new Date()).getTime(), + root = document.documentElement; + + form.innerHTML = "<a name='" + id + "'/>"; + + // Inject it into the root element, check its status, and remove it quickly + root.insertBefore( form, root.firstChild ); + + // The workaround has to do additional checks after a getElementById + // Which slows things down for other browsers (hence the branching) + if ( document.getElementById( id ) ) { + Expr.find.ID = function( match, context, isXML ) { + if ( typeof context.getElementById !== "undefined" && !isXML ) { + var m = context.getElementById(match[1]); + + return m ? + m.id === match[1] || typeof m.getAttributeNode !== "undefined" && m.getAttributeNode("id").nodeValue === match[1] ? + [m] : + undefined : + []; + } + }; + + Expr.filter.ID = function( elem, match ) { + var node = typeof elem.getAttributeNode !== "undefined" && elem.getAttributeNode("id"); + + return elem.nodeType === 1 && node && node.nodeValue === match; + }; + } + + root.removeChild( form ); + + // release memory in IE + root = form = null; +})(); + +(function(){ + // Check to see if the browser returns only elements + // when doing getElementsByTagName("*") + + // Create a fake element + var div = document.createElement("div"); + div.appendChild( document.createComment("") ); + + // Make sure no comments are found + if ( div.getElementsByTagName("*").length > 0 ) { + Expr.find.TAG = function( match, context ) { + var results = context.getElementsByTagName( match[1] ); + + // Filter out possible comments + if ( match[1] === "*" ) { + var tmp = []; + + for ( var i = 0; results[i]; i++ ) { + if ( results[i].nodeType === 1 ) { + tmp.push( results[i] ); + } + } + + results = tmp; + } + + return results; + }; + } + + // Check to see if an attribute returns normalized href attributes + div.innerHTML = "<a href='#'></a>"; + + if ( div.firstChild && typeof div.firstChild.getAttribute !== "undefined" && + div.firstChild.getAttribute("href") !== "#" ) { + + Expr.attrHandle.href = function( elem ) { + return elem.getAttribute( "href", 2 ); + }; + } + + // release memory in IE + div = null; +})(); + +if ( document.querySelectorAll ) { + (function(){ + var oldSizzle = Sizzle, + div = document.createElement("div"), + id = "__sizzle__"; + + div.innerHTML = "<p class='TEST'></p>"; + + // Safari can't handle uppercase or unicode characters when + // in quirks mode. + if ( div.querySelectorAll && div.querySelectorAll(".TEST").length === 0 ) { + return; + } + + Sizzle = function( query, context, extra, seed ) { + context = context || document; + + // Only use querySelectorAll on non-XML documents + // (ID selectors don't work in non-HTML documents) + if ( !seed && !Sizzle.isXML(context) ) { + // See if we find a selector to speed up + var match = /^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec( query ); + + if ( match && (context.nodeType === 1 || context.nodeType === 9) ) { + // Speed-up: Sizzle("TAG") + if ( match[1] ) { + return makeArray( context.getElementsByTagName( query ), extra ); + + // Speed-up: Sizzle(".CLASS") + } else if ( match[2] && Expr.find.CLASS && context.getElementsByClassName ) { + return makeArray( context.getElementsByClassName( match[2] ), extra ); + } + } + + if ( context.nodeType === 9 ) { + // Speed-up: Sizzle("body") + // The body element only exists once, optimize finding it + if ( query === "body" && context.body ) { + return makeArray( [ context.body ], extra ); + + // Speed-up: Sizzle("#ID") + } else if ( match && match[3] ) { + var elem = context.getElementById( match[3] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE and Opera return items + // by name instead of ID + if ( elem.id === match[3] ) { + return makeArray( [ elem ], extra ); + } + + } else { + return makeArray( [], extra ); + } + } + + try { + return makeArray( context.querySelectorAll(query), extra ); + } catch(qsaError) {} + + // qSA works strangely on Element-rooted queries + // We can work around this by specifying an extra ID on the root + // and working up from there (Thanks to Andrew Dupont for the technique) + // IE 8 doesn't work on object elements + } else if ( context.nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { + var oldContext = context, + old = context.getAttribute( "id" ), + nid = old || id, + hasParent = context.parentNode, + relativeHierarchySelector = /^\s*[+~]/.test( query ); + + if ( !old ) { + context.setAttribute( "id", nid ); + } else { + nid = nid.replace( /'/g, "\\$&" ); + } + if ( relativeHierarchySelector && hasParent ) { + context = context.parentNode; + } + + try { + if ( !relativeHierarchySelector || hasParent ) { + return makeArray( context.querySelectorAll( "[id='" + nid + "'] " + query ), extra ); + } + + } catch(pseudoError) { + } finally { + if ( !old ) { + oldContext.removeAttribute( "id" ); + } + } + } + } + + return oldSizzle(query, context, extra, seed); + }; + + for ( var prop in oldSizzle ) { + Sizzle[ prop ] = oldSizzle[ prop ]; + } + + // release memory in IE + div = null; + })(); +} + +(function(){ + var html = document.documentElement, + matches = html.matchesSelector || html.mozMatchesSelector || html.webkitMatchesSelector || html.msMatchesSelector; + + if ( matches ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9 fails this) + var disconnectedMatch = !matches.call( document.createElement( "div" ), "div" ), + pseudoWorks = false; + + try { + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( document.documentElement, "[test!='']:sizzle" ); + + } catch( pseudoError ) { + pseudoWorks = true; + } + + Sizzle.matchesSelector = function( node, expr ) { + // Make sure that attribute selectors are quoted + expr = expr.replace(/\=\s*([^'"\]]*)\s*\]/g, "='$1']"); + + if ( !Sizzle.isXML( node ) ) { + try { + if ( pseudoWorks || !Expr.match.PSEUDO.test( expr ) && !/!=/.test( expr ) ) { + var ret = matches.call( node, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || !disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9, so check for that + node.document && node.document.nodeType !== 11 ) { + return ret; + } + } + } catch(e) {} + } + + return Sizzle(expr, null, null, [node]).length > 0; + }; + } +})(); + +(function(){ + var div = document.createElement("div"); + + div.innerHTML = "<div class='test e'></div><div class='test'></div>"; + + // Opera can't find a second classname (in 9.6) + // Also, make sure that getElementsByClassName actually exists + if ( !div.getElementsByClassName || div.getElementsByClassName("e").length === 0 ) { + return; + } + + // Safari caches class attributes, doesn't catch changes (in 3.2) + div.lastChild.className = "e"; + + if ( div.getElementsByClassName("e").length === 1 ) { + return; + } + + Expr.order.splice(1, 0, "CLASS"); + Expr.find.CLASS = function( match, context, isXML ) { + if ( typeof context.getElementsByClassName !== "undefined" && !isXML ) { + return context.getElementsByClassName(match[1]); + } + }; + + // release memory in IE + div = null; +})(); + +function dirNodeCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) { + for ( var i = 0, l = checkSet.length; i < l; i++ ) { + var elem = checkSet[i]; + + if ( elem ) { + var match = false; + + elem = elem[dir]; + + while ( elem ) { + if ( elem[ expando ] === doneName ) { + match = checkSet[elem.sizset]; + break; + } + + if ( elem.nodeType === 1 && !isXML ){ + elem[ expando ] = doneName; + elem.sizset = i; + } + + if ( elem.nodeName.toLowerCase() === cur ) { + match = elem; + break; + } + + elem = elem[dir]; + } + + checkSet[i] = match; + } + } +} + +function dirCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) { + for ( var i = 0, l = checkSet.length; i < l; i++ ) { + var elem = checkSet[i]; + + if ( elem ) { + var match = false; + + elem = elem[dir]; + + while ( elem ) { + if ( elem[ expando ] === doneName ) { + match = checkSet[elem.sizset]; + break; + } + + if ( elem.nodeType === 1 ) { + if ( !isXML ) { + elem[ expando ] = doneName; + elem.sizset = i; + } + + if ( typeof cur !== "string" ) { + if ( elem === cur ) { + match = true; + break; + } + + } else if ( Sizzle.filter( cur, [elem] ).length > 0 ) { + match = elem; + break; + } + } + + elem = elem[dir]; + } + + checkSet[i] = match; + } + } +} + +if ( document.documentElement.contains ) { + Sizzle.contains = function( a, b ) { + return a !== b && (a.contains ? a.contains(b) : true); + }; + +} else if ( document.documentElement.compareDocumentPosition ) { + Sizzle.contains = function( a, b ) { + return !!(a.compareDocumentPosition(b) & 16); + }; + +} else { + Sizzle.contains = function() { + return false; + }; +} + +Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = (elem ? elem.ownerDocument || elem : 0).documentElement; + + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +var posProcess = function( selector, context, seed ) { + var match, + tmpSet = [], + later = "", + root = context.nodeType ? [context] : context; + + // Position selectors must be done after the filter + // And so must :not(positional) so we move all PSEUDOs to the end + while ( (match = Expr.match.PSEUDO.exec( selector )) ) { + later += match[0]; + selector = selector.replace( Expr.match.PSEUDO, "" ); + } + + selector = Expr.relative[selector] ? selector + "*" : selector; + + for ( var i = 0, l = root.length; i < l; i++ ) { + Sizzle( selector, root[i], tmpSet, seed ); + } + + return Sizzle.filter( later, tmpSet ); +}; + +// EXPOSE +// Override sizzle attribute retrieval +Sizzle.attr = jQuery.attr; +Sizzle.selectors.attrMap = {}; +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; +jQuery.expr[":"] = jQuery.expr.filters; +jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; + + +})(); + + +var runtil = /Until$/, + rparentsprev = /^(?:parents|prevUntil|prevAll)/, + // Note: This RegExp should be improved, or likely pulled from Sizzle + rmultiselector = /,/, + isSimple = /^.[^:#\[\.,]*$/, + slice = Array.prototype.slice, + POS = jQuery.expr.match.POS, + // methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend({ + find: function( selector ) { + var self = this, + i, l; + + if ( typeof selector !== "string" ) { + return jQuery( selector ).filter(function() { + for ( i = 0, l = self.length; i < l; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + }); + } + + var ret = this.pushStack( "", "find", selector ), + length, n, r; + + for ( i = 0, l = this.length; i < l; i++ ) { + length = ret.length; + jQuery.find( selector, this[i], ret ); + + if ( i > 0 ) { + // Make sure that the results are unique + for ( n = length; n < ret.length; n++ ) { + for ( r = 0; r < length; r++ ) { + if ( ret[r] === ret[n] ) { + ret.splice(n--, 1); + break; + } + } + } + } + } + + return ret; + }, + + has: function( target ) { + var targets = jQuery( target ); + return this.filter(function() { + for ( var i = 0, l = targets.length; i < l; i++ ) { + if ( jQuery.contains( this, targets[i] ) ) { + return true; + } + } + }); + }, + + not: function( selector ) { + return this.pushStack( winnow(this, selector, false), "not", selector); + }, + + filter: function( selector ) { + return this.pushStack( winnow(this, selector, true), "filter", selector ); + }, + + is: function( selector ) { + return !!selector && ( + typeof selector === "string" ? + // If this is a positional selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + POS.test( selector ) ? + jQuery( selector, this.context ).index( this[0] ) >= 0 : + jQuery.filter( selector, this ).length > 0 : + this.filter( selector ).length > 0 ); + }, + + closest: function( selectors, context ) { + var ret = [], i, l, cur = this[0]; + + // Array (deprecated as of jQuery 1.7) + if ( jQuery.isArray( selectors ) ) { + var level = 1; + + while ( cur && cur.ownerDocument && cur !== context ) { + for ( i = 0; i < selectors.length; i++ ) { + + if ( jQuery( cur ).is( selectors[ i ] ) ) { + ret.push({ selector: selectors[ i ], elem: cur, level: level }); + } + } + + cur = cur.parentNode; + level++; + } + + return ret; + } + + // String + var pos = POS.test( selectors ) || typeof selectors !== "string" ? + jQuery( selectors, context || this.context ) : + 0; + + for ( i = 0, l = this.length; i < l; i++ ) { + cur = this[i]; + + while ( cur ) { + if ( pos ? pos.index(cur) > -1 : jQuery.find.matchesSelector(cur, selectors) ) { + ret.push( cur ); + break; + + } else { + cur = cur.parentNode; + if ( !cur || !cur.ownerDocument || cur === context || cur.nodeType === 11 ) { + break; + } + } + } + } + + ret = ret.length > 1 ? jQuery.unique( ret ) : ret; + + return this.pushStack( ret, "closest", selectors ); + }, + + // Determine the position of an element within + // the matched set of elements + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[0] && this[0].parentNode ) ? this.prevAll().length : -1; + } + + // index in selector + if ( typeof elem === "string" ) { + return jQuery.inArray( this[0], jQuery( elem ) ); + } + + // Locate the position of the desired element + return jQuery.inArray( + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[0] : elem, this ); + }, + + add: function( selector, context ) { + var set = typeof selector === "string" ? + jQuery( selector, context ) : + jQuery.makeArray( selector && selector.nodeType ? [ selector ] : selector ), + all = jQuery.merge( this.get(), set ); + + return this.pushStack( isDisconnected( set[0] ) || isDisconnected( all[0] ) ? + all : + jQuery.unique( all ) ); + }, + + andSelf: function() { + return this.add( this.prevObject ); + } +}); + +// A painfully simple check to see if an element is disconnected +// from a document (should be improved, where feasible). +function isDisconnected( node ) { + return !node || !node.parentNode || node.parentNode.nodeType === 11; +} + +jQuery.each({ + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return jQuery.dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return jQuery.dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return jQuery.nth( elem, 2, "nextSibling" ); + }, + prev: function( elem ) { + return jQuery.nth( elem, 2, "previousSibling" ); + }, + nextAll: function( elem ) { + return jQuery.dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return jQuery.dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return jQuery.dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return jQuery.dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return jQuery.sibling( elem.parentNode.firstChild, elem ); + }, + children: function( elem ) { + return jQuery.sibling( elem.firstChild ); + }, + contents: function( elem ) { + return jQuery.nodeName( elem, "iframe" ) ? + elem.contentDocument || elem.contentWindow.document : + jQuery.makeArray( elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var ret = jQuery.map( this, fn, until ), + // The variable 'args' was introduced in + // https://github.com/jquery/jquery/commit/52a0238 + // to work around a bug in Chrome 10 (Dev) and should be removed when the bug is fixed. + // http://code.google.com/p/v8/issues/detail?id=1050 + args = slice.call(arguments); + + if ( !runtil.test( name ) ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + ret = jQuery.filter( selector, ret ); + } + + ret = this.length > 1 && !guaranteedUnique[ name ] ? jQuery.unique( ret ) : ret; + + if ( (this.length > 1 || rmultiselector.test( selector )) && rparentsprev.test( name ) ) { + ret = ret.reverse(); + } + + return this.pushStack( ret, name, args.join(",") ); + }; +}); + +jQuery.extend({ + filter: function( expr, elems, not ) { + if ( not ) { + expr = ":not(" + expr + ")"; + } + + return elems.length === 1 ? + jQuery.find.matchesSelector(elems[0], expr) ? [ elems[0] ] : [] : + jQuery.find.matches(expr, elems); + }, + + dir: function( elem, dir, until ) { + var matched = [], + cur = elem[ dir ]; + + while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) { + if ( cur.nodeType === 1 ) { + matched.push( cur ); + } + cur = cur[dir]; + } + return matched; + }, + + nth: function( cur, result, dir, elem ) { + result = result || 1; + var num = 0; + + for ( ; cur; cur = cur[dir] ) { + if ( cur.nodeType === 1 && ++num === result ) { + break; + } + } + + return cur; + }, + + sibling: function( n, elem ) { + var r = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + r.push( n ); + } + } + + return r; + } +}); + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, keep ) { + + // Can't pass null or undefined to indexOf in Firefox 4 + // Set to 0 to skip string check + qualifier = qualifier || 0; + + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep(elements, function( elem, i ) { + var retVal = !!qualifier.call( elem, i, elem ); + return retVal === keep; + }); + + } else if ( qualifier.nodeType ) { + return jQuery.grep(elements, function( elem, i ) { + return ( elem === qualifier ) === keep; + }); + + } else if ( typeof qualifier === "string" ) { + var filtered = jQuery.grep(elements, function( elem ) { + return elem.nodeType === 1; + }); + + if ( isSimple.test( qualifier ) ) { + return jQuery.filter(qualifier, filtered, !keep); + } else { + qualifier = jQuery.filter( qualifier, filtered ); + } + } + + return jQuery.grep(elements, function( elem, i ) { + return ( jQuery.inArray( elem, qualifier ) >= 0 ) === keep; + }); +} + + + + +function createSafeFragment( document ) { + var list = nodeNames.split( " " ), + safeFrag = document.createDocumentFragment(); + + if ( safeFrag.createElement ) { + while ( list.length ) { + safeFrag.createElement( + list.pop() + ); + } + } + return safeFrag; +} + +var nodeNames = "abbr article aside audio canvas datalist details figcaption figure footer " + + "header hgroup mark meter nav output progress section summary time video", + rinlinejQuery = / jQuery\d+="(?:\d+|null)"/g, + rleadingWhitespace = /^\s+/, + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig, + rtagName = /<([\w:]+)/, + rtbody = /<tbody/i, + rhtml = /<|&#?\w+;/, + rnoInnerhtml = /<(?:script|style)/i, + rnocache = /<(?:script|object|embed|option|style)/i, + rnoshimcache = new RegExp("<(?:" + nodeNames.replace(" ", "|") + ")", "i"), + // checked="checked" or checked + rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, + rscriptType = /\/(java|ecma)script/i, + rcleanScript = /^\s*<!(?:\[CDATA\[|\-\-)/, + wrapMap = { + option: [ 1, "<select multiple='multiple'>", "</select>" ], + legend: [ 1, "<fieldset>", "</fieldset>" ], + thead: [ 1, "<table>", "</table>" ], + tr: [ 2, "<table><tbody>", "</tbody></table>" ], + td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ], + col: [ 2, "<table><tbody></tbody><colgroup>", "</colgroup></table>" ], + area: [ 1, "<map>", "</map>" ], + _default: [ 0, "", "" ] + }, + safeFragment = createSafeFragment( document ); + +wrapMap.optgroup = wrapMap.option; +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// IE can't serialize <link> and <script> tags normally +if ( !jQuery.support.htmlSerialize ) { + wrapMap._default = [ 1, "div<div>", "</div>" ]; +} + +jQuery.fn.extend({ + text: function( text ) { + if ( jQuery.isFunction(text) ) { + return this.each(function(i) { + var self = jQuery( this ); + + self.text( text.call(this, i, self.text()) ); + }); + } + + if ( typeof text !== "object" && text !== undefined ) { + return this.empty().append( (this[0] && this[0].ownerDocument || document).createTextNode( text ) ); + } + + return jQuery.text( this ); + }, + + wrapAll: function( html ) { + if ( jQuery.isFunction( html ) ) { + return this.each(function(i) { + jQuery(this).wrapAll( html.call(this, i) ); + }); + } + + if ( this[0] ) { + // The elements to wrap the target around + var wrap = jQuery( html, this[0].ownerDocument ).eq(0).clone(true); + + if ( this[0].parentNode ) { + wrap.insertBefore( this[0] ); + } + + wrap.map(function() { + var elem = this; + + while ( elem.firstChild && elem.firstChild.nodeType === 1 ) { + elem = elem.firstChild; + } + + return elem; + }).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( jQuery.isFunction( html ) ) { + return this.each(function(i) { + jQuery(this).wrapInner( html.call(this, i) ); + }); + } + + return this.each(function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + }); + }, + + wrap: function( html ) { + return this.each(function() { + jQuery( this ).wrapAll( html ); + }); + }, + + unwrap: function() { + return this.parent().each(function() { + if ( !jQuery.nodeName( this, "body" ) ) { + jQuery( this ).replaceWith( this.childNodes ); + } + }).end(); + }, + + append: function() { + return this.domManip(arguments, true, function( elem ) { + if ( this.nodeType === 1 ) { + this.appendChild( elem ); + } + }); + }, + + prepend: function() { + return this.domManip(arguments, true, function( elem ) { + if ( this.nodeType === 1 ) { + this.insertBefore( elem, this.firstChild ); + } + }); + }, + + before: function() { + if ( this[0] && this[0].parentNode ) { + return this.domManip(arguments, false, function( elem ) { + this.parentNode.insertBefore( elem, this ); + }); + } else if ( arguments.length ) { + var set = jQuery(arguments[0]); + set.push.apply( set, this.toArray() ); + return this.pushStack( set, "before", arguments ); + } + }, + + after: function() { + if ( this[0] && this[0].parentNode ) { + return this.domManip(arguments, false, function( elem ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + }); + } else if ( arguments.length ) { + var set = this.pushStack( this, "after", arguments ); + set.push.apply( set, jQuery(arguments[0]).toArray() ); + return set; + } + }, + + // keepData is for internal use only--do not document + remove: function( selector, keepData ) { + for ( var i = 0, elem; (elem = this[i]) != null; i++ ) { + if ( !selector || jQuery.filter( selector, [ elem ] ).length ) { + if ( !keepData && elem.nodeType === 1 ) { + jQuery.cleanData( elem.getElementsByTagName("*") ); + jQuery.cleanData( [ elem ] ); + } + + if ( elem.parentNode ) { + elem.parentNode.removeChild( elem ); + } + } + } + + return this; + }, + + empty: function() { + for ( var i = 0, elem; (elem = this[i]) != null; i++ ) { + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( elem.getElementsByTagName("*") ); + } + + // Remove any remaining nodes + while ( elem.firstChild ) { + elem.removeChild( elem.firstChild ); + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function () { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + }); + }, + + html: function( value ) { + if ( value === undefined ) { + return this[0] && this[0].nodeType === 1 ? + this[0].innerHTML.replace(rinlinejQuery, "") : + null; + + // See if we can take a shortcut and just use innerHTML + } else if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + (jQuery.support.leadingWhitespace || !rleadingWhitespace.test( value )) && + !wrapMap[ (rtagName.exec( value ) || ["", ""])[1].toLowerCase() ] ) { + + value = value.replace(rxhtmlTag, "<$1></$2>"); + + try { + for ( var i = 0, l = this.length; i < l; i++ ) { + // Remove element nodes and prevent memory leaks + if ( this[i].nodeType === 1 ) { + jQuery.cleanData( this[i].getElementsByTagName("*") ); + this[i].innerHTML = value; + } + } + + // If using innerHTML throws an exception, use the fallback method + } catch(e) { + this.empty().append( value ); + } + + } else if ( jQuery.isFunction( value ) ) { + this.each(function(i){ + var self = jQuery( this ); + + self.html( value.call(this, i, self.html()) ); + }); + + } else { + this.empty().append( value ); + } + + return this; + }, + + replaceWith: function( value ) { + if ( this[0] && this[0].parentNode ) { + // Make sure that the elements are removed from the DOM before they are inserted + // this can help fix replacing a parent with child elements + if ( jQuery.isFunction( value ) ) { + return this.each(function(i) { + var self = jQuery(this), old = self.html(); + self.replaceWith( value.call( this, i, old ) ); + }); + } + + if ( typeof value !== "string" ) { + value = jQuery( value ).detach(); + } + + return this.each(function() { + var next = this.nextSibling, + parent = this.parentNode; + + jQuery( this ).remove(); + + if ( next ) { + jQuery(next).before( value ); + } else { + jQuery(parent).append( value ); + } + }); + } else { + return this.length ? + this.pushStack( jQuery(jQuery.isFunction(value) ? value() : value), "replaceWith", value ) : + this; + } + }, + + detach: function( selector ) { + return this.remove( selector, true ); + }, + + domManip: function( args, table, callback ) { + var results, first, fragment, parent, + value = args[0], + scripts = []; + + // We can't cloneNode fragments that contain checked, in WebKit + if ( !jQuery.support.checkClone && arguments.length === 3 && typeof value === "string" && rchecked.test( value ) ) { + return this.each(function() { + jQuery(this).domManip( args, table, callback, true ); + }); + } + + if ( jQuery.isFunction(value) ) { + return this.each(function(i) { + var self = jQuery(this); + args[0] = value.call(this, i, table ? self.html() : undefined); + self.domManip( args, table, callback ); + }); + } + + if ( this[0] ) { + parent = value && value.parentNode; + + // If we're in a fragment, just use that instead of building a new one + if ( jQuery.support.parentNode && parent && parent.nodeType === 11 && parent.childNodes.length === this.length ) { + results = { fragment: parent }; + + } else { + results = jQuery.buildFragment( args, this, scripts ); + } + + fragment = results.fragment; + + if ( fragment.childNodes.length === 1 ) { + first = fragment = fragment.firstChild; + } else { + first = fragment.firstChild; + } + + if ( first ) { + table = table && jQuery.nodeName( first, "tr" ); + + for ( var i = 0, l = this.length, lastIndex = l - 1; i < l; i++ ) { + callback.call( + table ? + root(this[i], first) : + this[i], + // Make sure that we do not leak memory by inadvertently discarding + // the original fragment (which might have attached data) instead of + // using it; in addition, use the original fragment object for the last + // item instead of first because it can end up being emptied incorrectly + // in certain situations (Bug #8070). + // Fragments from the fragment cache must always be cloned and never used + // in place. + results.cacheable || ( l > 1 && i < lastIndex ) ? + jQuery.clone( fragment, true, true ) : + fragment + ); + } + } + + if ( scripts.length ) { + jQuery.each( scripts, evalScript ); + } + } + + return this; + } +}); + +function root( elem, cur ) { + return jQuery.nodeName(elem, "table") ? + (elem.getElementsByTagName("tbody")[0] || + elem.appendChild(elem.ownerDocument.createElement("tbody"))) : + elem; +} + +function cloneCopyEvent( src, dest ) { + + if ( dest.nodeType !== 1 || !jQuery.hasData( src ) ) { + return; + } + + var type, i, l, + oldData = jQuery._data( src ), + curData = jQuery._data( dest, oldData ), + events = oldData.events; + + if ( events ) { + delete curData.handle; + curData.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type + ( events[ type ][ i ].namespace ? "." : "" ) + events[ type ][ i ].namespace, events[ type ][ i ], events[ type ][ i ].data ); + } + } + } + + // make the cloned public data object a copy from the original + if ( curData.data ) { + curData.data = jQuery.extend( {}, curData.data ); + } +} + +function cloneFixAttributes( src, dest ) { + var nodeName; + + // We do not need to do anything for non-Elements + if ( dest.nodeType !== 1 ) { + return; + } + + // clearAttributes removes the attributes, which we don't want, + // but also removes the attachEvent events, which we *do* want + if ( dest.clearAttributes ) { + dest.clearAttributes(); + } + + // mergeAttributes, in contrast, only merges back on the + // original attributes, not the events + if ( dest.mergeAttributes ) { + dest.mergeAttributes( src ); + } + + nodeName = dest.nodeName.toLowerCase(); + + // IE6-8 fail to clone children inside object elements that use + // the proprietary classid attribute value (rather than the type + // attribute) to identify the type of content to display + if ( nodeName === "object" ) { + dest.outerHTML = src.outerHTML; + + } else if ( nodeName === "input" && (src.type === "checkbox" || src.type === "radio") ) { + // IE6-8 fails to persist the checked state of a cloned checkbox + // or radio button. Worse, IE6-7 fail to give the cloned element + // a checked appearance if the defaultChecked value isn't also set + if ( src.checked ) { + dest.defaultChecked = dest.checked = src.checked; + } + + // IE6-7 get confused and end up setting the value of a cloned + // checkbox/radio button to an empty string instead of "on" + if ( dest.value !== src.value ) { + dest.value = src.value; + } + + // IE6-8 fails to return the selected option to the default selected + // state when cloning options + } else if ( nodeName === "option" ) { + dest.selected = src.defaultSelected; + + // IE6-8 fails to set the defaultValue to the correct value when + // cloning other types of input fields + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } + + // Event data gets referenced instead of copied if the expando + // gets copied too + dest.removeAttribute( jQuery.expando ); +} + +jQuery.buildFragment = function( args, nodes, scripts ) { + var fragment, cacheable, cacheresults, doc, + first = args[ 0 ]; + + // nodes may contain either an explicit document object, + // a jQuery collection or context object. + // If nodes[0] contains a valid object to assign to doc + if ( nodes && nodes[0] ) { + doc = nodes[0].ownerDocument || nodes[0]; + } + + // Ensure that an attr object doesn't incorrectly stand in as a document object + // Chrome and Firefox seem to allow this to occur and will throw exception + // Fixes #8950 + if ( !doc.createDocumentFragment ) { + doc = document; + } + + // Only cache "small" (1/2 KB) HTML strings that are associated with the main document + // Cloning options loses the selected state, so don't cache them + // IE 6 doesn't like it when you put <object> or <embed> elements in a fragment + // Also, WebKit does not clone 'checked' attributes on cloneNode, so don't cache + // Lastly, IE6,7,8 will not correctly reuse cached fragments that were created from unknown elems #10501 + if ( args.length === 1 && typeof first === "string" && first.length < 512 && doc === document && + first.charAt(0) === "<" && !rnocache.test( first ) && + (jQuery.support.checkClone || !rchecked.test( first )) && + (!jQuery.support.unknownElems && rnoshimcache.test( first )) ) { + + cacheable = true; + + cacheresults = jQuery.fragments[ first ]; + if ( cacheresults && cacheresults !== 1 ) { + fragment = cacheresults; + } + } + + if ( !fragment ) { + fragment = doc.createDocumentFragment(); + jQuery.clean( args, doc, fragment, scripts ); + } + + if ( cacheable ) { + jQuery.fragments[ first ] = cacheresults ? fragment : 1; + } + + return { fragment: fragment, cacheable: cacheable }; +}; + +jQuery.fragments = {}; + +jQuery.each({ + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var ret = [], + insert = jQuery( selector ), + parent = this.length === 1 && this[0].parentNode; + + if ( parent && parent.nodeType === 11 && parent.childNodes.length === 1 && insert.length === 1 ) { + insert[ original ]( this[0] ); + return this; + + } else { + for ( var i = 0, l = insert.length; i < l; i++ ) { + var elems = ( i > 0 ? this.clone(true) : this ).get(); + jQuery( insert[i] )[ original ]( elems ); + ret = ret.concat( elems ); + } + + return this.pushStack( ret, name, insert.selector ); + } + }; +}); + +function getAll( elem ) { + if ( typeof elem.getElementsByTagName !== "undefined" ) { + return elem.getElementsByTagName( "*" ); + + } else if ( typeof elem.querySelectorAll !== "undefined" ) { + return elem.querySelectorAll( "*" ); + + } else { + return []; + } +} + +// Used in clean, fixes the defaultChecked property +function fixDefaultChecked( elem ) { + if ( elem.type === "checkbox" || elem.type === "radio" ) { + elem.defaultChecked = elem.checked; + } +} +// Finds all inputs and passes them to fixDefaultChecked +function findInputs( elem ) { + var nodeName = ( elem.nodeName || "" ).toLowerCase(); + if ( nodeName === "input" ) { + fixDefaultChecked( elem ); + // Skip scripts, get other children + } else if ( nodeName !== "script" && typeof elem.getElementsByTagName !== "undefined" ) { + jQuery.grep( elem.getElementsByTagName("input"), fixDefaultChecked ); + } +} + +jQuery.extend({ + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var clone = elem.cloneNode(true), + srcElements, + destElements, + i; + + if ( (!jQuery.support.noCloneEvent || !jQuery.support.noCloneChecked) && + (elem.nodeType === 1 || elem.nodeType === 11) && !jQuery.isXMLDoc(elem) ) { + // IE copies events bound via attachEvent when using cloneNode. + // Calling detachEvent on the clone will also remove the events + // from the original. In order to get around this, we use some + // proprietary methods to clear the events. Thanks to MooTools + // guys for this hotness. + + cloneFixAttributes( elem, clone ); + + // Using Sizzle here is crazy slow, so we use getElementsByTagName + // instead + srcElements = getAll( elem ); + destElements = getAll( clone ); + + // Weird iteration because IE will replace the length property + // with an element if you are cloning the body and one of the + // elements on the page has a name or id of "length" + for ( i = 0; srcElements[i]; ++i ) { + // Ensure that the destination node is not null; Fixes #9587 + if ( destElements[i] ) { + cloneFixAttributes( srcElements[i], destElements[i] ); + } + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + cloneCopyEvent( elem, clone ); + + if ( deepDataAndEvents ) { + srcElements = getAll( elem ); + destElements = getAll( clone ); + + for ( i = 0; srcElements[i]; ++i ) { + cloneCopyEvent( srcElements[i], destElements[i] ); + } + } + } + + srcElements = destElements = null; + + // Return the cloned set + return clone; + }, + + clean: function( elems, context, fragment, scripts ) { + var checkScriptType; + + context = context || document; + + // !context.createElement fails in IE with an error but returns typeof 'object' + if ( typeof context.createElement === "undefined" ) { + context = context.ownerDocument || context[0] && context[0].ownerDocument || document; + } + + var ret = [], j; + + for ( var i = 0, elem; (elem = elems[i]) != null; i++ ) { + if ( typeof elem === "number" ) { + elem += ""; + } + + if ( !elem ) { + continue; + } + + // Convert html string into DOM nodes + if ( typeof elem === "string" ) { + if ( !rhtml.test( elem ) ) { + elem = context.createTextNode( elem ); + } else { + // Fix "XHTML"-style tags in all browsers + elem = elem.replace(rxhtmlTag, "<$1></$2>"); + + // Trim whitespace, otherwise indexOf won't work as expected + var tag = ( rtagName.exec( elem ) || ["", ""] )[1].toLowerCase(), + wrap = wrapMap[ tag ] || wrapMap._default, + depth = wrap[0], + div = context.createElement("div"); + + // Append wrapper element to unknown element safe doc fragment + if ( context === document ) { + // Use the fragment we've already created for this document + safeFragment.appendChild( div ); + } else { + // Use a fragment created with the owner document + createSafeFragment( context ).appendChild( div ); + } + + // Go to html and back, then peel off extra wrappers + div.innerHTML = wrap[1] + elem + wrap[2]; + + // Move to the right depth + while ( depth-- ) { + div = div.lastChild; + } + + // Remove IE's autoinserted <tbody> from table fragments + if ( !jQuery.support.tbody ) { + + // String was a <table>, *may* have spurious <tbody> + var hasBody = rtbody.test(elem), + tbody = tag === "table" && !hasBody ? + div.firstChild && div.firstChild.childNodes : + + // String was a bare <thead> or <tfoot> + wrap[1] === "<table>" && !hasBody ? + div.childNodes : + []; + + for ( j = tbody.length - 1; j >= 0 ; --j ) { + if ( jQuery.nodeName( tbody[ j ], "tbody" ) && !tbody[ j ].childNodes.length ) { + tbody[ j ].parentNode.removeChild( tbody[ j ] ); + } + } + } + + // IE completely kills leading whitespace when innerHTML is used + if ( !jQuery.support.leadingWhitespace && rleadingWhitespace.test( elem ) ) { + div.insertBefore( context.createTextNode( rleadingWhitespace.exec(elem)[0] ), div.firstChild ); + } + + elem = div.childNodes; + } + } + + // Resets defaultChecked for any radios and checkboxes + // about to be appended to the DOM in IE 6/7 (#8060) + var len; + if ( !jQuery.support.appendChecked ) { + if ( elem[0] && typeof (len = elem.length) === "number" ) { + for ( j = 0; j < len; j++ ) { + findInputs( elem[j] ); + } + } else { + findInputs( elem ); + } + } + + if ( elem.nodeType ) { + ret.push( elem ); + } else { + ret = jQuery.merge( ret, elem ); + } + } + + if ( fragment ) { + checkScriptType = function( elem ) { + return !elem.type || rscriptType.test( elem.type ); + }; + for ( i = 0; ret[i]; i++ ) { + if ( scripts && jQuery.nodeName( ret[i], "script" ) && (!ret[i].type || ret[i].type.toLowerCase() === "text/javascript") ) { + scripts.push( ret[i].parentNode ? ret[i].parentNode.removeChild( ret[i] ) : ret[i] ); + + } else { + if ( ret[i].nodeType === 1 ) { + var jsTags = jQuery.grep( ret[i].getElementsByTagName( "script" ), checkScriptType ); + + ret.splice.apply( ret, [i + 1, 0].concat( jsTags ) ); + } + fragment.appendChild( ret[i] ); + } + } + } + + return ret; + }, + + cleanData: function( elems ) { + var data, id, + cache = jQuery.cache, + special = jQuery.event.special, + deleteExpando = jQuery.support.deleteExpando; + + for ( var i = 0, elem; (elem = elems[i]) != null; i++ ) { + if ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) { + continue; + } + + id = elem[ jQuery.expando ]; + + if ( id ) { + data = cache[ id ]; + + if ( data && data.events ) { + for ( var type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + + // Null the DOM reference to avoid IE6/7/8 leak (#7054) + if ( data.handle ) { + data.handle.elem = null; + } + } + + if ( deleteExpando ) { + delete elem[ jQuery.expando ]; + + } else if ( elem.removeAttribute ) { + elem.removeAttribute( jQuery.expando ); + } + + delete cache[ id ]; + } + } + } +}); + +function evalScript( i, elem ) { + if ( elem.src ) { + jQuery.ajax({ + url: elem.src, + async: false, + dataType: "script" + }); + } else { + jQuery.globalEval( ( elem.text || elem.textContent || elem.innerHTML || "" ).replace( rcleanScript, "/*$0*/" ) ); + } + + if ( elem.parentNode ) { + elem.parentNode.removeChild( elem ); + } +} + + + + +var ralpha = /alpha\([^)]*\)/i, + ropacity = /opacity=([^)]*)/, + // fixed for IE9, see #8346 + rupper = /([A-Z]|^ms)/g, + rnumpx = /^-?\d+(?:px)?$/i, + rnum = /^-?\d/, + rrelNum = /^([\-+])=([\-+.\de]+)/, + + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssWidth = [ "Left", "Right" ], + cssHeight = [ "Top", "Bottom" ], + curCSS, + + getComputedStyle, + currentStyle; + +jQuery.fn.css = function( name, value ) { + // Setting 'undefined' is a no-op + if ( arguments.length === 2 && value === undefined ) { + return this; + } + + return jQuery.access( this, name, value, true, function( elem, name, value ) { + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }); +}; + +jQuery.extend({ + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity", "opacity" ); + return ret === "" ? "1" : ret; + + } else { + return elem.style.opacity; + } + } + } + }, + + // Exclude the following css properties to add px + cssNumber: { + "fillOpacity": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: { + // normalize float css property + "float": jQuery.support.cssFloat ? "cssFloat" : "styleFloat" + }, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, origName = jQuery.camelCase( name ), + style = elem.style, hooks = jQuery.cssHooks[ origName ]; + + name = jQuery.cssProps[ origName ] || origName; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // convert relative number strings (+= or -=) to relative numbers. #7345 + if ( type === "string" && (ret = rrelNum.exec( value )) ) { + value = ( +( ret[1] + 1) * +ret[2] ) + parseFloat( jQuery.css( elem, name ) ); + // Fixes bug #9237 + type = "number"; + } + + // Make sure that NaN and null values aren't set. See: #7116 + if ( value == null || type === "number" && isNaN( value ) ) { + return; + } + + // If a number was passed in, add 'px' to the (except for certain CSS properties) + if ( type === "number" && !jQuery.cssNumber[ origName ] ) { + value += "px"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !("set" in hooks) || (value = hooks.set( elem, value )) !== undefined ) { + // Wrapped to prevent IE from throwing errors when 'invalid' values are provided + // Fixes bug #5509 + try { + style[ name ] = value; + } catch(e) {} + } + + } else { + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && (ret = hooks.get( elem, false, extra )) !== undefined ) { + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra ) { + var ret, hooks; + + // Make sure that we're working with the right name + name = jQuery.camelCase( name ); + hooks = jQuery.cssHooks[ name ]; + name = jQuery.cssProps[ name ] || name; + + // cssFloat needs a special treatment + if ( name === "cssFloat" ) { + name = "float"; + } + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks && (ret = hooks.get( elem, true, extra )) !== undefined ) { + return ret; + + // Otherwise, if a way to get the computed value exists, use that + } else if ( curCSS ) { + return curCSS( elem, name ); + } + }, + + // A method for quickly swapping in/out CSS properties to get correct calculations + swap: function( elem, options, callback ) { + var old = {}; + + // Remember the old values, and insert the new ones + for ( var name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + } +}); + +// DEPRECATED, Use jQuery.css() instead +jQuery.curCSS = jQuery.css; + +jQuery.each(["height", "width"], function( i, name ) { + jQuery.cssHooks[ name ] = { + get: function( elem, computed, extra ) { + var val; + + if ( computed ) { + if ( elem.offsetWidth !== 0 ) { + return getWH( elem, name, extra ); + } else { + jQuery.swap( elem, cssShow, function() { + val = getWH( elem, name, extra ); + }); + } + + return val; + } + }, + + set: function( elem, value ) { + if ( rnumpx.test( value ) ) { + // ignore negative width and height values #1599 + value = parseFloat( value ); + + if ( value >= 0 ) { + return value + "px"; + } + + } else { + return value; + } + } + }; +}); + +if ( !jQuery.support.opacity ) { + jQuery.cssHooks.opacity = { + get: function( elem, computed ) { + // IE uses filters for opacity + return ropacity.test( (computed && elem.currentStyle ? elem.currentStyle.filter : elem.style.filter) || "" ) ? + ( parseFloat( RegExp.$1 ) / 100 ) + "" : + computed ? "1" : ""; + }, + + set: function( elem, value ) { + var style = elem.style, + currentStyle = elem.currentStyle, + opacity = jQuery.isNumeric( value ) ? "alpha(opacity=" + value * 100 + ")" : "", + filter = currentStyle && currentStyle.filter || style.filter || ""; + + // IE has trouble with opacity if it does not have layout + // Force it by setting the zoom level + style.zoom = 1; + + // if setting opacity to 1, and no other filters exist - attempt to remove filter attribute #6652 + if ( value >= 1 && jQuery.trim( filter.replace( ralpha, "" ) ) === "" ) { + + // Setting style.filter to null, "" & " " still leave "filter:" in the cssText + // if "filter:" is present at all, clearType is disabled, we want to avoid this + // style.removeAttribute is IE Only, but so apparently is this code path... + style.removeAttribute( "filter" ); + + // if there there is no filter style applied in a css rule, we are done + if ( currentStyle && !currentStyle.filter ) { + return; + } + } + + // otherwise, set new filter values + style.filter = ralpha.test( filter ) ? + filter.replace( ralpha, opacity ) : + filter + " " + opacity; + } + }; +} + +jQuery(function() { + // This hook cannot be added until DOM ready because the support test + // for it is not run until after DOM ready + if ( !jQuery.support.reliableMarginRight ) { + jQuery.cssHooks.marginRight = { + get: function( elem, computed ) { + // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right + // Work around by temporarily setting element display to inline-block + var ret; + jQuery.swap( elem, { "display": "inline-block" }, function() { + if ( computed ) { + ret = curCSS( elem, "margin-right", "marginRight" ); + } else { + ret = elem.style.marginRight; + } + }); + return ret; + } + }; + } +}); + +if ( document.defaultView && document.defaultView.getComputedStyle ) { + getComputedStyle = function( elem, name ) { + var ret, defaultView, computedStyle; + + name = name.replace( rupper, "-$1" ).toLowerCase(); + + if ( !(defaultView = elem.ownerDocument.defaultView) ) { + return undefined; + } + + if ( (computedStyle = defaultView.getComputedStyle( elem, null )) ) { + ret = computedStyle.getPropertyValue( name ); + if ( ret === "" && !jQuery.contains( elem.ownerDocument.documentElement, elem ) ) { + ret = jQuery.style( elem, name ); + } + } + + return ret; + }; +} + +if ( document.documentElement.currentStyle ) { + currentStyle = function( elem, name ) { + var left, rsLeft, uncomputed, + ret = elem.currentStyle && elem.currentStyle[ name ], + style = elem.style; + + // Avoid setting ret to empty string here + // so we don't default to auto + if ( ret === null && style && (uncomputed = style[ name ]) ) { + ret = uncomputed; + } + + // From the awesome hack by Dean Edwards + // http://erik.eae.net/archives/2007/07/27/18.54.15/#comment-102291 + + // If we're not dealing with a regular pixel number + // but a number that has a weird ending, we need to convert it to pixels + if ( !rnumpx.test( ret ) && rnum.test( ret ) ) { + + // Remember the original values + left = style.left; + rsLeft = elem.runtimeStyle && elem.runtimeStyle.left; + + // Put in the new values to get a computed value out + if ( rsLeft ) { + elem.runtimeStyle.left = elem.currentStyle.left; + } + style.left = name === "fontSize" ? "1em" : ( ret || 0 ); + ret = style.pixelLeft + "px"; + + // Revert the changed values + style.left = left; + if ( rsLeft ) { + elem.runtimeStyle.left = rsLeft; + } + } + + return ret === "" ? "auto" : ret; + }; +} + +curCSS = getComputedStyle || currentStyle; + +function getWH( elem, name, extra ) { + + // Start with offset property + var val = name === "width" ? elem.offsetWidth : elem.offsetHeight, + which = name === "width" ? cssWidth : cssHeight; + + if ( val > 0 ) { + if ( extra !== "border" ) { + jQuery.each( which, function() { + if ( !extra ) { + val -= parseFloat( jQuery.css( elem, "padding" + this ) ) || 0; + } + if ( extra === "margin" ) { + val += parseFloat( jQuery.css( elem, extra + this ) ) || 0; + } else { + val -= parseFloat( jQuery.css( elem, "border" + this + "Width" ) ) || 0; + } + }); + } + + return val + "px"; + } + + // Fall back to computed then uncomputed css if necessary + val = curCSS( elem, name, name ); + if ( val < 0 || val == null ) { + val = elem.style[ name ] || 0; + } + // Normalize "", auto, and prepare for extra + val = parseFloat( val ) || 0; + + // Add padding, border, margin + if ( extra ) { + jQuery.each( which, function() { + val += parseFloat( jQuery.css( elem, "padding" + this ) ) || 0; + if ( extra !== "padding" ) { + val += parseFloat( jQuery.css( elem, "border" + this + "Width" ) ) || 0; + } + if ( extra === "margin" ) { + val += parseFloat( jQuery.css( elem, extra + this ) ) || 0; + } + }); + } + + return val + "px"; +} + +if ( jQuery.expr && jQuery.expr.filters ) { + jQuery.expr.filters.hidden = function( elem ) { + var width = elem.offsetWidth, + height = elem.offsetHeight; + + return ( width === 0 && height === 0 ) || (!jQuery.support.reliableHiddenOffsets && ((elem.style && elem.style.display) || jQuery.css( elem, "display" )) === "none"); + }; + + jQuery.expr.filters.visible = function( elem ) { + return !jQuery.expr.filters.hidden( elem ); + }; +} + + + + +var r20 = /%20/g, + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rhash = /#.*$/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)\r?$/mg, // IE leaves an \r character at EOL + rinput = /^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i, + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + rquery = /\?/, + rscript = /<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi, + rselectTextarea = /^(?:select|textarea)/i, + rspacesAjax = /\s+/, + rts = /([?&])_=[^&]*/, + rurl = /^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/, + + // Keep a copy of the old load method + _load = jQuery.fn.load, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Document location + ajaxLocation, + + // Document location segments + ajaxLocParts, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = ["*/"] + ["*"]; + +// #8138, IE may throw an exception when accessing +// a field from window.location if document.domain has been set +try { + ajaxLocation = location.href; +} catch( e ) { + // Use the href attribute of an A element + // since IE will modify it given document.location + ajaxLocation = document.createElement( "a" ); + ajaxLocation.href = ""; + ajaxLocation = ajaxLocation.href; +} + +// Segment location into parts +ajaxLocParts = rurl.exec( ajaxLocation.toLowerCase() ) || []; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + if ( jQuery.isFunction( func ) ) { + var dataTypes = dataTypeExpression.toLowerCase().split( rspacesAjax ), + i = 0, + length = dataTypes.length, + dataType, + list, + placeBefore; + + // For each dataType in the dataTypeExpression + for ( ; i < length; i++ ) { + dataType = dataTypes[ i ]; + // We control if we're asked to add before + // any existing element + placeBefore = /^\+/.test( dataType ); + if ( placeBefore ) { + dataType = dataType.substr( 1 ) || "*"; + } + list = structure[ dataType ] = structure[ dataType ] || []; + // then we add to the structure accordingly + list[ placeBefore ? "unshift" : "push" ]( func ); + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR, + dataType /* internal */, inspected /* internal */ ) { + + dataType = dataType || options.dataTypes[ 0 ]; + inspected = inspected || {}; + + inspected[ dataType ] = true; + + var list = structure[ dataType ], + i = 0, + length = list ? list.length : 0, + executeOnly = ( structure === prefilters ), + selection; + + for ( ; i < length && ( executeOnly || !selection ); i++ ) { + selection = list[ i ]( options, originalOptions, jqXHR ); + // If we got redirected to another dataType + // we try there if executing only and not done already + if ( typeof selection === "string" ) { + if ( !executeOnly || inspected[ selection ] ) { + selection = undefined; + } else { + options.dataTypes.unshift( selection ); + selection = inspectPrefiltersOrTransports( + structure, options, originalOptions, jqXHR, selection, inspected ); + } + } + } + // If we're only executing or nothing was selected + // we try the catchall dataType if not done already + if ( ( executeOnly || !selection ) && !inspected[ "*" ] ) { + selection = inspectPrefiltersOrTransports( + structure, options, originalOptions, jqXHR, "*", inspected ); + } + // unnecessary when only executing (prefilters) + // but it'll be ignored by the caller in that case + return selection; +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } +} + +jQuery.fn.extend({ + load: function( url, params, callback ) { + if ( typeof url !== "string" && _load ) { + return _load.apply( this, arguments ); + + // Don't do a request if no elements are being requested + } else if ( !this.length ) { + return this; + } + + var off = url.indexOf( " " ); + if ( off >= 0 ) { + var selector = url.slice( off, url.length ); + url = url.slice( 0, off ); + } + + // Default to a GET request + var type = "GET"; + + // If the second parameter was provided + if ( params ) { + // If it's a function + if ( jQuery.isFunction( params ) ) { + // We assume that it's the callback + callback = params; + params = undefined; + + // Otherwise, build a param string + } else if ( typeof params === "object" ) { + params = jQuery.param( params, jQuery.ajaxSettings.traditional ); + type = "POST"; + } + } + + var self = this; + + // Request the remote document + jQuery.ajax({ + url: url, + type: type, + dataType: "html", + data: params, + // Complete callback (responseText is used internally) + complete: function( jqXHR, status, responseText ) { + // Store the response as specified by the jqXHR object + responseText = jqXHR.responseText; + // If successful, inject the HTML into all the matched elements + if ( jqXHR.isResolved() ) { + // #4825: Get the actual response in case + // a dataFilter is present in ajaxSettings + jqXHR.done(function( r ) { + responseText = r; + }); + // See if a selector was specified + self.html( selector ? + // Create a dummy div to hold the results + jQuery("<div>") + // inject the contents of the document in, removing the scripts + // to avoid any 'Permission Denied' errors in IE + .append(responseText.replace(rscript, "")) + + // Locate the specified elements + .find(selector) : + + // If not, just inject the full result + responseText ); + } + + if ( callback ) { + self.each( callback, [ responseText, status, jqXHR ] ); + } + } + }); + + return this; + }, + + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + + serializeArray: function() { + return this.map(function(){ + return this.elements ? jQuery.makeArray( this.elements ) : this; + }) + .filter(function(){ + return this.name && !this.disabled && + ( this.checked || rselectTextarea.test( this.nodeName ) || + rinput.test( this.type ) ); + }) + .map(function( i, elem ){ + var val = jQuery( this ).val(); + + return val == null ? + null : + jQuery.isArray( val ) ? + jQuery.map( val, function( val, i ){ + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + }) : + { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + }).get(); + } +}); + +// Attach a bunch of functions for handling common AJAX events +jQuery.each( "ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split( " " ), function( i, o ){ + jQuery.fn[ o ] = function( f ){ + return this.bind( o, f ); + }; +}); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + // shift arguments if data argument was omitted + if ( jQuery.isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + return jQuery.ajax({ + type: method, + url: url, + data: data, + success: callback, + dataType: type + }); + }; +}); + +jQuery.extend({ + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + if ( settings ) { + // Building a settings object + ajaxExtend( target, jQuery.ajaxSettings ); + } else { + // Extending ajaxSettings + settings = target; + target = jQuery.ajaxSettings; + } + ajaxExtend( target, settings ); + return target; + }, + + ajaxSettings: { + url: ajaxLocation, + isLocal: rlocalProtocol.test( ajaxLocParts[ 1 ] ), + global: true, + type: "GET", + contentType: "application/x-www-form-urlencoded", + processData: true, + async: true, + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + traditional: false, + headers: {}, + */ + + accepts: { + xml: "application/xml, text/xml", + html: "text/html", + text: "text/plain", + json: "application/json, text/javascript", + "*": allTypes + }, + + contents: { + xml: /xml/, + html: /html/, + json: /json/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText" + }, + + // List of data converters + // 1) key format is "source_type destination_type" (a single space in-between) + // 2) the catchall symbol "*" can be used for source_type + converters: { + + // Convert anything to text + "* text": window.String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": jQuery.parseJSON, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + context: true, + url: true + } + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + // Callbacks context + callbackContext = s.context || s, + // Context for global events + // It's the callbackContext if one was provided in the options + // and if it's a DOM node or a jQuery collection + globalEventContext = callbackContext !== s && + ( callbackContext.nodeType || callbackContext instanceof jQuery ) ? + jQuery( callbackContext ) : jQuery.event, + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + // Status-dependent callbacks + statusCode = s.statusCode || {}, + // ifModified key + ifModifiedKey, + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + // Response headers + responseHeadersString, + responseHeaders, + // transport + transport, + // timeout handle + timeoutTimer, + // Cross-domain detection vars + parts, + // The jqXHR state + state = 0, + // To know if global events are to be dispatched + fireGlobals, + // Loop variable + i, + // Fake xhr + jqXHR = { + + readyState: 0, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( !state ) { + var lname = name.toLowerCase(); + name = requestHeadersNames[ lname ] = requestHeadersNames[ lname ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Raw string + getAllResponseHeaders: function() { + return state === 2 ? responseHeadersString : null; + }, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( state === 2 ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[1].toLowerCase() ] = match[ 2 ]; + } + } + match = responseHeaders[ key.toLowerCase() ]; + } + return match === undefined ? null : match; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( !state ) { + s.mimeType = type; + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + statusText = statusText || "abort"; + if ( transport ) { + transport.abort( statusText ); + } + done( 0, statusText ); + return this; + } + }; + + // Callback for when everything is done + // It is defined here because jslint complains if it is declared + // at the end of the function (which would be more logical and readable) + function done( status, nativeStatusText, responses, headers ) { + + // Called once + if ( state === 2 ) { + return; + } + + // State is "done" now + state = 2; + + // Clear timeout if it exists + if ( timeoutTimer ) { + clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + var isSuccess, + success, + error, + statusText = nativeStatusText, + response = responses ? ajaxHandleResponses( s, jqXHR, responses ) : undefined, + lastModified, + etag; + + // If successful, handle type chaining + if ( status >= 200 && status < 300 || status === 304 ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + + if ( ( lastModified = jqXHR.getResponseHeader( "Last-Modified" ) ) ) { + jQuery.lastModified[ ifModifiedKey ] = lastModified; + } + if ( ( etag = jqXHR.getResponseHeader( "Etag" ) ) ) { + jQuery.etag[ ifModifiedKey ] = etag; + } + } + + // If not modified + if ( status === 304 ) { + + statusText = "notmodified"; + isSuccess = true; + + // If we have data + } else { + + try { + success = ajaxConvert( s, response ); + statusText = "success"; + isSuccess = true; + } catch(e) { + // We have a parsererror + statusText = "parsererror"; + error = e; + } + } + } else { + // We extract error from statusText + // then normalize statusText and status for non-aborts + error = statusText; + if ( !statusText || status ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = "" + ( nativeStatusText || statusText ); + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( "ajax" + ( isSuccess ? "Success" : "Error" ), + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + // Attach deferreds + deferred.promise( jqXHR ); + jqXHR.success = jqXHR.done; + jqXHR.error = jqXHR.fail; + jqXHR.complete = completeDeferred.add; + + // Status-dependent callbacks + jqXHR.statusCode = function( map ) { + if ( map ) { + var tmp; + if ( state < 2 ) { + for ( tmp in map ) { + statusCode[ tmp ] = [ statusCode[tmp], map[tmp] ]; + } + } else { + tmp = map[ jqXHR.status ]; + jqXHR.then( tmp, tmp ); + } + } + return this; + }; + + // Remove hash character (#7531: and string promotion) + // Add protocol if not provided (#5866: IE7 issue with protocol-less urls) + // We also use the url parameter if available + s.url = ( ( url || s.url ) + "" ).replace( rhash, "" ).replace( rprotocol, ajaxLocParts[ 1 ] + "//" ); + + // Extract dataTypes list + s.dataTypes = jQuery.trim( s.dataType || "*" ).toLowerCase().split( rspacesAjax ); + + // Determine if a cross-domain request is in order + if ( s.crossDomain == null ) { + parts = rurl.exec( s.url.toLowerCase() ); + s.crossDomain = !!( parts && + ( parts[ 1 ] != ajaxLocParts[ 1 ] || parts[ 2 ] != ajaxLocParts[ 2 ] || + ( parts[ 3 ] || ( parts[ 1 ] === "http:" ? 80 : 443 ) ) != + ( ajaxLocParts[ 3 ] || ( ajaxLocParts[ 1 ] === "http:" ? 80 : 443 ) ) ) + ); + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefiler, stop there + if ( state === 2 ) { + return false; + } + + // We can fire global events as of now if asked to + fireGlobals = s.global; + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // If data is available, append data to url + if ( s.data ) { + s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.data; + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Get ifModifiedKey before adding the anti-cache parameter + ifModifiedKey = s.url; + + // Add anti-cache in url if needed + if ( s.cache === false ) { + + var ts = jQuery.now(), + // try replacing _= if it is there + ret = s.url.replace( rts, "$1_=" + ts ); + + // if nothing was replaced, add timestamp to the end + s.url = ret + ( ( ret === s.url ) ? ( rquery.test( s.url ) ? "&" : "?" ) + "_=" + ts : "" ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + ifModifiedKey = ifModifiedKey || s.url; + if ( jQuery.lastModified[ ifModifiedKey ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ ifModifiedKey ] ); + } + if ( jQuery.etag[ ifModifiedKey ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ ifModifiedKey ] ); + } + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[0] ] ? + s.accepts[ s.dataTypes[0] ] + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || state === 2 ) ) { + // Abort if not done already + jqXHR.abort(); + return false; + + } + + // Install callbacks on deferreds + for ( i in { success: 1, error: 1, complete: 1 } ) { + jqXHR[ i ]( s[ i ] ); + } + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = setTimeout( function(){ + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + state = 1; + transport.send( requestHeaders, done ); + } catch (e) { + // Propagate exception as error if not done + if ( state < 2 ) { + done( -1, e ); + // Simply rethrow otherwise + } else { + jQuery.error( e ); + } + } + } + + return jqXHR; + }, + + // Serialize an array of form elements or a set of + // key/values into a query string + param: function( a, traditional ) { + var s = [], + add = function( key, value ) { + // If value is a function, invoke it and return its value + value = jQuery.isFunction( value ) ? value() : value; + s[ s.length ] = encodeURIComponent( key ) + "=" + encodeURIComponent( value ); + }; + + // Set traditional to true for jQuery <= 1.3.2 behavior. + if ( traditional === undefined ) { + traditional = jQuery.ajaxSettings.traditional; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( jQuery.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + }); + + } else { + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( var prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ).replace( r20, "+" ); + } +}); + +function buildParams( prefix, obj, traditional, add ) { + if ( jQuery.isArray( obj ) ) { + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + // If array item is non-scalar (array or object), encode its + // numeric index to resolve deserialization ambiguity issues. + // Note that rack (as of 1.0.0) can't currently deserialize + // nested arrays properly, and attempting to do so may cause + // a server error. Possible fixes are to modify rack's + // deserialization algorithm or to provide an option or flag + // to force array serialization to be shallow. + buildParams( prefix + "[" + ( typeof v === "object" || jQuery.isArray(v) ? i : "" ) + "]", v, traditional, add ); + } + }); + + } else if ( !traditional && obj != null && typeof obj === "object" ) { + // Serialize object item. + for ( var name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + // Serialize scalar item. + add( prefix, obj ); + } +} + +// This is still on the jQuery object... for now +// Want to move this to jQuery.ajax some day +jQuery.extend({ + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {} + +}); + +/* Handles responses to an ajax request: + * - sets all responseXXX fields accordingly + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var contents = s.contents, + dataTypes = s.dataTypes, + responseFields = s.responseFields, + ct, + type, + finalDataType, + firstDataType; + + // Fill responseXXX fields + for ( type in responseFields ) { + if ( type in responses ) { + jqXHR[ responseFields[type] ] = responses[ type ]; + } + } + + // Remove auto dataType and get content-type in the process + while( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "content-type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[0] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +// Chain conversions given the request and the original response +function ajaxConvert( s, response ) { + + // Apply the dataFilter if provided + if ( s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + var dataTypes = s.dataTypes, + converters = {}, + i, + key, + length = dataTypes.length, + tmp, + // Current and previous dataTypes + current = dataTypes[ 0 ], + prev, + // Conversion expression + conversion, + // Conversion function + conv, + // Conversion functions (transitive conversion) + conv1, + conv2; + + // For each dataType in the chain + for ( i = 1; i < length; i++ ) { + + // Create converters map + // with lowercased keys + if ( i === 1 ) { + for ( key in s.converters ) { + if ( typeof key === "string" ) { + converters[ key.toLowerCase() ] = s.converters[ key ]; + } + } + } + + // Get the dataTypes + prev = current; + current = dataTypes[ i ]; + + // If current is auto dataType, update it to prev + if ( current === "*" ) { + current = prev; + // If no auto and dataTypes are actually different + } else if ( prev !== "*" && prev !== current ) { + + // Get the converter + conversion = prev + " " + current; + conv = converters[ conversion ] || converters[ "* " + current ]; + + // If there is no direct converter, search transitively + if ( !conv ) { + conv2 = undefined; + for ( conv1 in converters ) { + tmp = conv1.split( " " ); + if ( tmp[ 0 ] === prev || tmp[ 0 ] === "*" ) { + conv2 = converters[ tmp[1] + " " + current ]; + if ( conv2 ) { + conv1 = converters[ conv1 ]; + if ( conv1 === true ) { + conv = conv2; + } else if ( conv2 === true ) { + conv = conv1; + } + break; + } + } + } + } + // If we found no converter, dispatch an error + if ( !( conv || conv2 ) ) { + jQuery.error( "No conversion from " + conversion.replace(" "," to ") ); + } + // If found converter is not an equivalence + if ( conv !== true ) { + // Convert with 1 or 2 converters accordingly + response = conv ? conv( response ) : conv2( conv1(response) ); + } + } + } + return response; +} + + + + +var jsc = jQuery.now(), + jsre = /(\=)\?(&|$)|\?\?/i; + +// Default jsonp settings +jQuery.ajaxSetup({ + jsonp: "callback", + jsonpCallback: function() { + return jQuery.expando + "_" + ( jsc++ ); + } +}); + +// Detect, normalize options and install callbacks for jsonp requests +jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) { + + var inspectData = s.contentType === "application/x-www-form-urlencoded" && + ( typeof s.data === "string" ); + + if ( s.dataTypes[ 0 ] === "jsonp" || + s.jsonp !== false && ( jsre.test( s.url ) || + inspectData && jsre.test( s.data ) ) ) { + + var responseContainer, + jsonpCallback = s.jsonpCallback = + jQuery.isFunction( s.jsonpCallback ) ? s.jsonpCallback() : s.jsonpCallback, + previous = window[ jsonpCallback ], + url = s.url, + data = s.data, + replace = "$1" + jsonpCallback + "$2"; + + if ( s.jsonp !== false ) { + url = url.replace( jsre, replace ); + if ( s.url === url ) { + if ( inspectData ) { + data = data.replace( jsre, replace ); + } + if ( s.data === data ) { + // Add callback manually + url += (/\?/.test( url ) ? "&" : "?") + s.jsonp + "=" + jsonpCallback; + } + } + } + + s.url = url; + s.data = data; + + // Install callback + window[ jsonpCallback ] = function( response ) { + responseContainer = [ response ]; + }; + + // Clean-up function + jqXHR.always(function() { + // Set callback back to previous value + window[ jsonpCallback ] = previous; + // Call if it was a function and we have a response + if ( responseContainer && jQuery.isFunction( previous ) ) { + window[ jsonpCallback ]( responseContainer[ 0 ] ); + } + }); + + // Use data converter to retrieve json after script execution + s.converters["script json"] = function() { + if ( !responseContainer ) { + jQuery.error( jsonpCallback + " was not called" ); + } + return responseContainer[ 0 ]; + }; + + // force json dataType + s.dataTypes[ 0 ] = "json"; + + // Delegate to script + return "script"; + } +}); + + + + +// Install script dataType +jQuery.ajaxSetup({ + accepts: { + script: "text/javascript, application/javascript, application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /javascript|ecmascript/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +}); + +// Handle cache's special case and global +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + s.global = false; + } +}); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function(s) { + + // This transport only deals with cross domain requests + if ( s.crossDomain ) { + + var script, + head = document.head || document.getElementsByTagName( "head" )[0] || document.documentElement; + + return { + + send: function( _, callback ) { + + script = document.createElement( "script" ); + + script.async = "async"; + + if ( s.scriptCharset ) { + script.charset = s.scriptCharset; + } + + script.src = s.url; + + // Attach handlers for all browsers + script.onload = script.onreadystatechange = function( _, isAbort ) { + + if ( isAbort || !script.readyState || /loaded|complete/.test( script.readyState ) ) { + + // Handle memory leak in IE + script.onload = script.onreadystatechange = null; + + // Remove the script + if ( head && script.parentNode ) { + head.removeChild( script ); + } + + // Dereference the script + script = undefined; + + // Callback if not abort + if ( !isAbort ) { + callback( 200, "success" ); + } + } + }; + // Use insertBefore instead of appendChild to circumvent an IE6 bug. + // This arises when a base node is used (#2709 and #4378). + head.insertBefore( script, head.firstChild ); + }, + + abort: function() { + if ( script ) { + script.onload( 0, 1 ); + } + } + }; + } +}); + + + + +var // #5280: Internet Explorer will keep connections alive if we don't abort on unload + xhrOnUnloadAbort = window.ActiveXObject ? function() { + // Abort all pending requests + for ( var key in xhrCallbacks ) { + xhrCallbacks[ key ]( 0, 1 ); + } + } : false, + xhrId = 0, + xhrCallbacks; + +// Functions to create xhrs +function createStandardXHR() { + try { + return new window.XMLHttpRequest(); + } catch( e ) {} +} + +function createActiveXHR() { + try { + return new window.ActiveXObject( "Microsoft.XMLHTTP" ); + } catch( e ) {} +} + +// Create the request object +// (This is still attached to ajaxSettings for backward compatibility) +jQuery.ajaxSettings.xhr = window.ActiveXObject ? + /* Microsoft failed to properly + * implement the XMLHttpRequest in IE7 (can't request local files), + * so we use the ActiveXObject when it is available + * Additionally XMLHttpRequest can be disabled in IE7/IE8 so + * we need a fallback. + */ + function() { + return !this.isLocal && createStandardXHR() || createActiveXHR(); + } : + // For all other browsers, use the standard XMLHttpRequest object + createStandardXHR; + +// Determine support properties +(function( xhr ) { + jQuery.extend( jQuery.support, { + ajax: !!xhr, + cors: !!xhr && ( "withCredentials" in xhr ) + }); +})( jQuery.ajaxSettings.xhr() ); + +// Create transport if the browser can provide an xhr +if ( jQuery.support.ajax ) { + + jQuery.ajaxTransport(function( s ) { + // Cross domain only allowed if supported through XMLHttpRequest + if ( !s.crossDomain || jQuery.support.cors ) { + + var callback; + + return { + send: function( headers, complete ) { + + // Get a new xhr + var xhr = s.xhr(), + handle, + i; + + // Open the socket + // Passing null username, generates a login popup on Opera (#2865) + if ( s.username ) { + xhr.open( s.type, s.url, s.async, s.username, s.password ); + } else { + xhr.open( s.type, s.url, s.async ); + } + + // Apply custom fields if provided + if ( s.xhrFields ) { + for ( i in s.xhrFields ) { + xhr[ i ] = s.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( s.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( s.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !s.crossDomain && !headers["X-Requested-With"] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Need an extra try/catch for cross domain requests in Firefox 3 + try { + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + } catch( _ ) {} + + // Do send the request + // This may raise an exception which is actually + // handled in jQuery.ajax (so no try/catch here) + xhr.send( ( s.hasContent && s.data ) || null ); + + // Listener + callback = function( _, isAbort ) { + + var status, + statusText, + responseHeaders, + responses, + xml; + + // Firefox throws exceptions when accessing properties + // of an xhr when a network error occured + // http://helpful.knobs-dials.com/index.php/Component_returned_failure_code:_0x80040111_(NS_ERROR_NOT_AVAILABLE) + try { + + // Was never called and is aborted or complete + if ( callback && ( isAbort || xhr.readyState === 4 ) ) { + + // Only called once + callback = undefined; + + // Do not keep as active anymore + if ( handle ) { + xhr.onreadystatechange = jQuery.noop; + if ( xhrOnUnloadAbort ) { + delete xhrCallbacks[ handle ]; + } + } + + // If it's an abort + if ( isAbort ) { + // Abort it manually if needed + if ( xhr.readyState !== 4 ) { + xhr.abort(); + } + } else { + status = xhr.status; + responseHeaders = xhr.getAllResponseHeaders(); + responses = {}; + xml = xhr.responseXML; + + // Construct response list + if ( xml && xml.documentElement /* #4958 */ ) { + responses.xml = xml; + } + responses.text = xhr.responseText; + + // Firefox throws an exception when accessing + // statusText for faulty cross-domain requests + try { + statusText = xhr.statusText; + } catch( e ) { + // We normalize with Webkit giving an empty statusText + statusText = ""; + } + + // Filter status for non standard behaviors + + // If the request is local and we have data: assume a success + // (success with no data won't get notified, that's the best we + // can do given current implementations) + if ( !status && s.isLocal && !s.crossDomain ) { + status = responses.text ? 200 : 404; + // IE - #1450: sometimes returns 1223 when it should be 204 + } else if ( status === 1223 ) { + status = 204; + } + } + } + } catch( firefoxAccessException ) { + if ( !isAbort ) { + complete( -1, firefoxAccessException ); + } + } + + // Call complete if needed + if ( responses ) { + complete( status, statusText, responses, responseHeaders ); + } + }; + + // if we're in sync mode or it's in cache + // and has been retrieved directly (IE6 & IE7) + // we need to manually fire the callback + if ( !s.async || xhr.readyState === 4 ) { + callback(); + } else { + handle = ++xhrId; + if ( xhrOnUnloadAbort ) { + // Create the active xhrs callbacks list if needed + // and attach the unload handler + if ( !xhrCallbacks ) { + xhrCallbacks = {}; + jQuery( window ).unload( xhrOnUnloadAbort ); + } + // Add to list of active xhrs callbacks + xhrCallbacks[ handle ] = callback; + } + xhr.onreadystatechange = callback; + } + }, + + abort: function() { + if ( callback ) { + callback(0,1); + } + } + }; + } + }); +} + + + + +var elemdisplay = {}, + iframe, iframeDoc, + rfxtypes = /^(?:toggle|show|hide)$/, + rfxnum = /^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i, + timerId, + fxAttrs = [ + // height animations + [ "height", "marginTop", "marginBottom", "paddingTop", "paddingBottom" ], + // width animations + [ "width", "marginLeft", "marginRight", "paddingLeft", "paddingRight" ], + // opacity animations + [ "opacity" ] + ], + fxNow; + +jQuery.fn.extend({ + show: function( speed, easing, callback ) { + var elem, display; + + if ( speed || speed === 0 ) { + return this.animate( genFx("show", 3), speed, easing, callback ); + + } else { + for ( var i = 0, j = this.length; i < j; i++ ) { + elem = this[ i ]; + + if ( elem.style ) { + display = elem.style.display; + + // Reset the inline display of this element to learn if it is + // being hidden by cascaded rules or not + if ( !jQuery._data(elem, "olddisplay") && display === "none" ) { + display = elem.style.display = ""; + } + + // Set elements which have been overridden with display: none + // in a stylesheet to whatever the default browser style is + // for such an element + if ( display === "" && jQuery.css(elem, "display") === "none" ) { + jQuery._data( elem, "olddisplay", defaultDisplay(elem.nodeName) ); + } + } + } + + // Set the display of most of the elements in a second loop + // to avoid the constant reflow + for ( i = 0; i < j; i++ ) { + elem = this[ i ]; + + if ( elem.style ) { + display = elem.style.display; + + if ( display === "" || display === "none" ) { + elem.style.display = jQuery._data( elem, "olddisplay" ) || ""; + } + } + } + + return this; + } + }, + + hide: function( speed, easing, callback ) { + if ( speed || speed === 0 ) { + return this.animate( genFx("hide", 3), speed, easing, callback); + + } else { + var elem, display, + i = 0, + j = this.length; + + for ( ; i < j; i++ ) { + elem = this[i]; + if ( elem.style ) { + display = jQuery.css( elem, "display" ); + + if ( display !== "none" && !jQuery._data( elem, "olddisplay" ) ) { + jQuery._data( elem, "olddisplay", display ); + } + } + } + + // Set the display of the elements in a second loop + // to avoid the constant reflow + for ( i = 0; i < j; i++ ) { + if ( this[i].style ) { + this[i].style.display = "none"; + } + } + + return this; + } + }, + + // Save the old toggle function + _toggle: jQuery.fn.toggle, + + toggle: function( fn, fn2, callback ) { + var bool = typeof fn === "boolean"; + + if ( jQuery.isFunction(fn) && jQuery.isFunction(fn2) ) { + this._toggle.apply( this, arguments ); + + } else if ( fn == null || bool ) { + this.each(function() { + var state = bool ? fn : jQuery(this).is(":hidden"); + jQuery(this)[ state ? "show" : "hide" ](); + }); + + } else { + this.animate(genFx("toggle", 3), fn, fn2, callback); + } + + return this; + }, + + fadeTo: function( speed, to, easing, callback ) { + return this.filter(":hidden").css("opacity", 0).show().end() + .animate({opacity: to}, speed, easing, callback); + }, + + animate: function( prop, speed, easing, callback ) { + var optall = jQuery.speed( speed, easing, callback ); + + if ( jQuery.isEmptyObject( prop ) ) { + return this.each( optall.complete, [ false ] ); + } + + // Do not change referenced properties as per-property easing will be lost + prop = jQuery.extend( {}, prop ); + + function doAnimation() { + // XXX 'this' does not always have a nodeName when running the + // test suite + + if ( optall.queue === false ) { + jQuery._mark( this ); + } + + var opt = jQuery.extend( {}, optall ), + isElement = this.nodeType === 1, + hidden = isElement && jQuery(this).is(":hidden"), + name, val, p, e, + parts, start, end, unit, + method; + + // will store per property easing and be used to determine when an animation is complete + opt.animatedProperties = {}; + + for ( p in prop ) { + + // property name normalization + name = jQuery.camelCase( p ); + if ( p !== name ) { + prop[ name ] = prop[ p ]; + delete prop[ p ]; + } + + val = prop[ name ]; + + // easing resolution: per property > opt.specialEasing > opt.easing > 'swing' (default) + if ( jQuery.isArray( val ) ) { + opt.animatedProperties[ name ] = val[ 1 ]; + val = prop[ name ] = val[ 0 ]; + } else { + opt.animatedProperties[ name ] = opt.specialEasing && opt.specialEasing[ name ] || opt.easing || 'swing'; + } + + if ( val === "hide" && hidden || val === "show" && !hidden ) { + return opt.complete.call( this ); + } + + if ( isElement && ( name === "height" || name === "width" ) ) { + // Make sure that nothing sneaks out + // Record all 3 overflow attributes because IE does not + // change the overflow attribute when overflowX and + // overflowY are set to the same value + opt.overflow = [ this.style.overflow, this.style.overflowX, this.style.overflowY ]; + + // Set display property to inline-block for height/width + // animations on inline elements that are having width/height animated + if ( jQuery.css( this, "display" ) === "inline" && + jQuery.css( this, "float" ) === "none" ) { + + // inline-level elements accept inline-block; + // block-level elements need to be inline with layout + if ( !jQuery.support.inlineBlockNeedsLayout || defaultDisplay( this.nodeName ) === "inline" ) { + this.style.display = "inline-block"; + + } else { + this.style.zoom = 1; + } + } + } + } + + if ( opt.overflow != null ) { + this.style.overflow = "hidden"; + } + + for ( p in prop ) { + e = new jQuery.fx( this, opt, p ); + val = prop[ p ]; + + if ( rfxtypes.test( val ) ) { + + // Tracks whether to show or hide based on private + // data attached to the element + method = jQuery._data( this, "toggle" + p ) || ( val === "toggle" ? hidden ? "show" : "hide" : 0 ); + if ( method ) { + jQuery._data( this, "toggle" + p, method === "show" ? "hide" : "show" ); + e[ method ](); + } else { + e[ val ](); + } + + } else { + parts = rfxnum.exec( val ); + start = e.cur(); + + if ( parts ) { + end = parseFloat( parts[2] ); + unit = parts[3] || ( jQuery.cssNumber[ p ] ? "" : "px" ); + + // We need to compute starting value + if ( unit !== "px" ) { + jQuery.style( this, p, (end || 1) + unit); + start = ( (end || 1) / e.cur() ) * start; + jQuery.style( this, p, start + unit); + } + + // If a +=/-= token was provided, we're doing a relative animation + if ( parts[1] ) { + end = ( (parts[ 1 ] === "-=" ? -1 : 1) * end ) + start; + } + + e.custom( start, end, unit ); + + } else { + e.custom( start, val, "" ); + } + } + } + + // For JS strict compliance + return true; + } + + return optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + + stop: function( type, clearQueue, gotoEnd ) { + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each(function() { + var i, + hadTimers = false, + timers = jQuery.timers, + data = jQuery._data( this ); + + // clear marker counters if we know they won't be + if ( !gotoEnd ) { + jQuery._unmark( true, this ); + } + + function stopQueue( elem, data, i ) { + var hooks = data[ i ]; + jQuery.removeData( elem, i, true ); + hooks.stop( gotoEnd ); + } + + if ( type == null ) { + for ( i in data ) { + if ( data[ i ].stop && i.indexOf(".run") === i.length - 4 ) { + stopQueue( this, data, i ); + } + } + } else if ( data[ i = type + ".run" ] && data[ i ].stop ){ + stopQueue( this, data, i ); + } + + for ( i = timers.length; i--; ) { + if ( timers[ i ].elem === this && (type == null || timers[ i ].queue === type) ) { + if ( gotoEnd ) { + + // force the next step to be the last + timers[ i ]( true ); + } else { + timers[ i ].saveState(); + } + hadTimers = true; + timers.splice( i, 1 ); + } + } + + // start the next in the queue if the last step wasn't forced + // timers currently will call their complete callbacks, which will dequeue + // but only if they were gotoEnd + if ( !( gotoEnd && hadTimers ) ) { + jQuery.dequeue( this, type ); + } + }); + } + +}); + +// Animations created synchronously will run synchronously +function createFxNow() { + setTimeout( clearFxNow, 0 ); + return ( fxNow = jQuery.now() ); +} + +function clearFxNow() { + fxNow = undefined; +} + +// Generate parameters to create a standard animation +function genFx( type, num ) { + var obj = {}; + + jQuery.each( fxAttrs.concat.apply([], fxAttrs.slice( 0, num )), function() { + obj[ this ] = type; + }); + + return obj; +} + +// Generate shortcuts for custom animations +jQuery.each({ + slideDown: genFx( "show", 1 ), + slideUp: genFx( "hide", 1 ), + slideToggle: genFx( "toggle", 1 ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +}); + +jQuery.extend({ + speed: function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + jQuery.isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing + }; + + opt.duration = jQuery.fx.off ? 0 : typeof opt.duration === "number" ? opt.duration : + opt.duration in jQuery.fx.speeds ? jQuery.fx.speeds[ opt.duration ] : jQuery.fx.speeds._default; + + // normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function( noUnmark ) { + if ( jQuery.isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } else if ( noUnmark !== false ) { + jQuery._unmark( this ); + } + }; + + return opt; + }, + + easing: { + linear: function( p, n, firstNum, diff ) { + return firstNum + diff * p; + }, + swing: function( p, n, firstNum, diff ) { + return ( ( -Math.cos( p*Math.PI ) / 2 ) + 0.5 ) * diff + firstNum; + } + }, + + timers: [], + + fx: function( elem, options, prop ) { + this.options = options; + this.elem = elem; + this.prop = prop; + + options.orig = options.orig || {}; + } + +}); + +jQuery.fx.prototype = { + // Simple function for setting a style value + update: function() { + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + ( jQuery.fx.step[ this.prop ] || jQuery.fx.step._default )( this ); + }, + + // Get the current size + cur: function() { + if ( this.elem[ this.prop ] != null && (!this.elem.style || this.elem.style[ this.prop ] == null) ) { + return this.elem[ this.prop ]; + } + + var parsed, + r = jQuery.css( this.elem, this.prop ); + // Empty strings, null, undefined and "auto" are converted to 0, + // complex values such as "rotate(1rad)" are returned as is, + // simple values such as "10px" are parsed to Float. + return isNaN( parsed = parseFloat( r ) ) ? !r || r === "auto" ? 0 : r : parsed; + }, + + // Start an animation from one number to another + custom: function( from, to, unit ) { + var self = this, + fx = jQuery.fx; + + this.startTime = fxNow || createFxNow(); + this.end = to; + this.now = this.start = from; + this.pos = this.state = 0; + this.unit = unit || this.unit || ( jQuery.cssNumber[ this.prop ] ? "" : "px" ); + + function t( gotoEnd ) { + return self.step( gotoEnd ); + } + + t.queue = this.options.queue; + t.elem = this.elem; + t.saveState = function() { + if ( self.options.hide && jQuery._data( self.elem, "fxshow" + self.prop ) === undefined ) { + jQuery._data( self.elem, "fxshow" + self.prop, self.start ); + } + }; + + if ( t() && jQuery.timers.push(t) && !timerId ) { + timerId = setInterval( fx.tick, fx.interval ); + } + }, + + // Simple 'show' function + show: function() { + var dataShow = jQuery._data( this.elem, "fxshow" + this.prop ); + + // Remember where we started, so that we can go back to it later + this.options.orig[ this.prop ] = dataShow || jQuery.style( this.elem, this.prop ); + this.options.show = true; + + // Begin the animation + // Make sure that we start at a small width/height to avoid any flash of content + if ( dataShow !== undefined ) { + // This show is picking up where a previous hide or show left off + this.custom( this.cur(), dataShow ); + } else { + this.custom( this.prop === "width" || this.prop === "height" ? 1 : 0, this.cur() ); + } + + // Start by showing the element + jQuery( this.elem ).show(); + }, + + // Simple 'hide' function + hide: function() { + // Remember where we started, so that we can go back to it later + this.options.orig[ this.prop ] = jQuery._data( this.elem, "fxshow" + this.prop ) || jQuery.style( this.elem, this.prop ); + this.options.hide = true; + + // Begin the animation + this.custom( this.cur(), 0 ); + }, + + // Each step of an animation + step: function( gotoEnd ) { + var p, n, complete, + t = fxNow || createFxNow(), + done = true, + elem = this.elem, + options = this.options; + + if ( gotoEnd || t >= options.duration + this.startTime ) { + this.now = this.end; + this.pos = this.state = 1; + this.update(); + + options.animatedProperties[ this.prop ] = true; + + for ( p in options.animatedProperties ) { + if ( options.animatedProperties[ p ] !== true ) { + done = false; + } + } + + if ( done ) { + // Reset the overflow + if ( options.overflow != null && !jQuery.support.shrinkWrapBlocks ) { + + jQuery.each( [ "", "X", "Y" ], function( index, value ) { + elem.style[ "overflow" + value ] = options.overflow[ index ]; + }); + } + + // Hide the element if the "hide" operation was done + if ( options.hide ) { + jQuery( elem ).hide(); + } + + // Reset the properties, if the item has been hidden or shown + if ( options.hide || options.show ) { + for ( p in options.animatedProperties ) { + jQuery.style( elem, p, options.orig[ p ] ); + jQuery.removeData( elem, "fxshow" + p, true ); + // Toggle data is no longer needed + jQuery.removeData( elem, "toggle" + p, true ); + } + } + + // Execute the complete function + // in the event that the complete function throws an exception + // we must ensure it won't be called twice. #5684 + + complete = options.complete; + if ( complete ) { + + options.complete = false; + complete.call( elem ); + } + } + + return false; + + } else { + // classical easing cannot be used with an Infinity duration + if ( options.duration == Infinity ) { + this.now = t; + } else { + n = t - this.startTime; + this.state = n / options.duration; + + // Perform the easing function, defaults to swing + this.pos = jQuery.easing[ options.animatedProperties[this.prop] ]( this.state, n, 0, 1, options.duration ); + this.now = this.start + ( (this.end - this.start) * this.pos ); + } + // Perform the next step of the animation + this.update(); + } + + return true; + } +}; + +jQuery.extend( jQuery.fx, { + tick: function() { + var timer, + timers = jQuery.timers, + i = 0; + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + // Checks the timer has not already been removed + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + }, + + interval: 13, + + stop: function() { + clearInterval( timerId ); + timerId = null; + }, + + speeds: { + slow: 600, + fast: 200, + // Default speed + _default: 400 + }, + + step: { + opacity: function( fx ) { + jQuery.style( fx.elem, "opacity", fx.now ); + }, + + _default: function( fx ) { + if ( fx.elem.style && fx.elem.style[ fx.prop ] != null ) { + fx.elem.style[ fx.prop ] = fx.now + fx.unit; + } else { + fx.elem[ fx.prop ] = fx.now; + } + } + } +}); + +// Adds width/height step functions +// Do not set anything below 0 +jQuery.each([ "width", "height" ], function( i, prop ) { + jQuery.fx.step[ prop ] = function( fx ) { + jQuery.style( fx.elem, prop, Math.max(0, fx.now) ); + }; +}); + +if ( jQuery.expr && jQuery.expr.filters ) { + jQuery.expr.filters.animated = function( elem ) { + return jQuery.grep(jQuery.timers, function( fn ) { + return elem === fn.elem; + }).length; + }; +} + +// Try to restore the default display value of an element +function defaultDisplay( nodeName ) { + + if ( !elemdisplay[ nodeName ] ) { + + var body = document.body, + elem = jQuery( "<" + nodeName + ">" ).appendTo( body ), + display = elem.css( "display" ); + elem.remove(); + + // If the simple way fails, + // get element's real default display by attaching it to a temp iframe + if ( display === "none" || display === "" ) { + // No iframe to use yet, so create it + if ( !iframe ) { + iframe = document.createElement( "iframe" ); + iframe.frameBorder = iframe.width = iframe.height = 0; + } + + body.appendChild( iframe ); + + // Create a cacheable copy of the iframe document on first call. + // IE and Opera will allow us to reuse the iframeDoc without re-writing the fake HTML + // document to it; WebKit & Firefox won't allow reusing the iframe document. + if ( !iframeDoc || !iframe.createElement ) { + iframeDoc = ( iframe.contentWindow || iframe.contentDocument ).document; + iframeDoc.write( ( document.compatMode === "CSS1Compat" ? "<!doctype html>" : "" ) + "<html><body>" ); + iframeDoc.close(); + } + + elem = iframeDoc.createElement( nodeName ); + + iframeDoc.body.appendChild( elem ); + + display = jQuery.css( elem, "display" ); + body.removeChild( iframe ); + } + + // Store the correct default display + elemdisplay[ nodeName ] = display; + } + + return elemdisplay[ nodeName ]; +} + + + + +var rtable = /^t(?:able|d|h)$/i, + rroot = /^(?:body|html)$/i; + +if ( "getBoundingClientRect" in document.documentElement ) { + jQuery.fn.offset = function( options ) { + var elem = this[0], box; + + if ( options ) { + return this.each(function( i ) { + jQuery.offset.setOffset( this, options, i ); + }); + } + + if ( !elem || !elem.ownerDocument ) { + return null; + } + + if ( elem === elem.ownerDocument.body ) { + return jQuery.offset.bodyOffset( elem ); + } + + try { + box = elem.getBoundingClientRect(); + } catch(e) {} + + var doc = elem.ownerDocument, + docElem = doc.documentElement; + + // Make sure we're not dealing with a disconnected DOM node + if ( !box || !jQuery.contains( docElem, elem ) ) { + return box ? { top: box.top, left: box.left } : { top: 0, left: 0 }; + } + + var body = doc.body, + win = getWindow(doc), + clientTop = docElem.clientTop || body.clientTop || 0, + clientLeft = docElem.clientLeft || body.clientLeft || 0, + scrollTop = win.pageYOffset || jQuery.support.boxModel && docElem.scrollTop || body.scrollTop, + scrollLeft = win.pageXOffset || jQuery.support.boxModel && docElem.scrollLeft || body.scrollLeft, + top = box.top + scrollTop - clientTop, + left = box.left + scrollLeft - clientLeft; + + return { top: top, left: left }; + }; + +} else { + jQuery.fn.offset = function( options ) { + var elem = this[0]; + + if ( options ) { + return this.each(function( i ) { + jQuery.offset.setOffset( this, options, i ); + }); + } + + if ( !elem || !elem.ownerDocument ) { + return null; + } + + if ( elem === elem.ownerDocument.body ) { + return jQuery.offset.bodyOffset( elem ); + } + + var computedStyle, + offsetParent = elem.offsetParent, + prevOffsetParent = elem, + doc = elem.ownerDocument, + docElem = doc.documentElement, + body = doc.body, + defaultView = doc.defaultView, + prevComputedStyle = defaultView ? defaultView.getComputedStyle( elem, null ) : elem.currentStyle, + top = elem.offsetTop, + left = elem.offsetLeft; + + while ( (elem = elem.parentNode) && elem !== body && elem !== docElem ) { + if ( jQuery.support.fixedPosition && prevComputedStyle.position === "fixed" ) { + break; + } + + computedStyle = defaultView ? defaultView.getComputedStyle(elem, null) : elem.currentStyle; + top -= elem.scrollTop; + left -= elem.scrollLeft; + + if ( elem === offsetParent ) { + top += elem.offsetTop; + left += elem.offsetLeft; + + if ( jQuery.support.doesNotAddBorder && !(jQuery.support.doesAddBorderForTableAndCells && rtable.test(elem.nodeName)) ) { + top += parseFloat( computedStyle.borderTopWidth ) || 0; + left += parseFloat( computedStyle.borderLeftWidth ) || 0; + } + + prevOffsetParent = offsetParent; + offsetParent = elem.offsetParent; + } + + if ( jQuery.support.subtractsBorderForOverflowNotVisible && computedStyle.overflow !== "visible" ) { + top += parseFloat( computedStyle.borderTopWidth ) || 0; + left += parseFloat( computedStyle.borderLeftWidth ) || 0; + } + + prevComputedStyle = computedStyle; + } + + if ( prevComputedStyle.position === "relative" || prevComputedStyle.position === "static" ) { + top += body.offsetTop; + left += body.offsetLeft; + } + + if ( jQuery.support.fixedPosition && prevComputedStyle.position === "fixed" ) { + top += Math.max( docElem.scrollTop, body.scrollTop ); + left += Math.max( docElem.scrollLeft, body.scrollLeft ); + } + + return { top: top, left: left }; + }; +} + +jQuery.offset = { + + bodyOffset: function( body ) { + var top = body.offsetTop, + left = body.offsetLeft; + + if ( jQuery.support.doesNotIncludeMarginInBodyOffset ) { + top += parseFloat( jQuery.css(body, "marginTop") ) || 0; + left += parseFloat( jQuery.css(body, "marginLeft") ) || 0; + } + + return { top: top, left: left }; + }, + + setOffset: function( elem, options, i ) { + var position = jQuery.css( elem, "position" ); + + // set position first, in-case top/left are set even on static elem + if ( position === "static" ) { + elem.style.position = "relative"; + } + + var curElem = jQuery( elem ), + curOffset = curElem.offset(), + curCSSTop = jQuery.css( elem, "top" ), + curCSSLeft = jQuery.css( elem, "left" ), + calculatePosition = ( position === "absolute" || position === "fixed" ) && jQuery.inArray("auto", [curCSSTop, curCSSLeft]) > -1, + props = {}, curPosition = {}, curTop, curLeft; + + // need to be able to calculate position if either top or left is auto and position is either absolute or fixed + if ( calculatePosition ) { + curPosition = curElem.position(); + curTop = curPosition.top; + curLeft = curPosition.left; + } else { + curTop = parseFloat( curCSSTop ) || 0; + curLeft = parseFloat( curCSSLeft ) || 0; + } + + if ( jQuery.isFunction( options ) ) { + options = options.call( elem, i, curOffset ); + } + + if ( options.top != null ) { + props.top = ( options.top - curOffset.top ) + curTop; + } + if ( options.left != null ) { + props.left = ( options.left - curOffset.left ) + curLeft; + } + + if ( "using" in options ) { + options.using.call( elem, props ); + } else { + curElem.css( props ); + } + } +}; + + +jQuery.fn.extend({ + + position: function() { + if ( !this[0] ) { + return null; + } + + var elem = this[0], + + // Get *real* offsetParent + offsetParent = this.offsetParent(), + + // Get correct offsets + offset = this.offset(), + parentOffset = rroot.test(offsetParent[0].nodeName) ? { top: 0, left: 0 } : offsetParent.offset(); + + // Subtract element margins + // note: when an element has margin: auto the offsetLeft and marginLeft + // are the same in Safari causing offset.left to incorrectly be 0 + offset.top -= parseFloat( jQuery.css(elem, "marginTop") ) || 0; + offset.left -= parseFloat( jQuery.css(elem, "marginLeft") ) || 0; + + // Add offsetParent borders + parentOffset.top += parseFloat( jQuery.css(offsetParent[0], "borderTopWidth") ) || 0; + parentOffset.left += parseFloat( jQuery.css(offsetParent[0], "borderLeftWidth") ) || 0; + + // Subtract the two offsets + return { + top: offset.top - parentOffset.top, + left: offset.left - parentOffset.left + }; + }, + + offsetParent: function() { + return this.map(function() { + var offsetParent = this.offsetParent || document.body; + while ( offsetParent && (!rroot.test(offsetParent.nodeName) && jQuery.css(offsetParent, "position") === "static") ) { + offsetParent = offsetParent.offsetParent; + } + return offsetParent; + }); + } +}); + + +// Create scrollLeft and scrollTop methods +jQuery.each( ["Left", "Top"], function( i, name ) { + var method = "scroll" + name; + + jQuery.fn[ method ] = function( val ) { + var elem, win; + + if ( val === undefined ) { + elem = this[ 0 ]; + + if ( !elem ) { + return null; + } + + win = getWindow( elem ); + + // Return the scroll offset + return win ? ("pageXOffset" in win) ? win[ i ? "pageYOffset" : "pageXOffset" ] : + jQuery.support.boxModel && win.document.documentElement[ method ] || + win.document.body[ method ] : + elem[ method ]; + } + + // Set the scroll offset + return this.each(function() { + win = getWindow( this ); + + if ( win ) { + win.scrollTo( + !i ? val : jQuery( win ).scrollLeft(), + i ? val : jQuery( win ).scrollTop() + ); + + } else { + this[ method ] = val; + } + }); + }; +}); + +function getWindow( elem ) { + return jQuery.isWindow( elem ) ? + elem : + elem.nodeType === 9 ? + elem.defaultView || elem.parentWindow : + false; +} + + + + +// Create width, height, innerHeight, innerWidth, outerHeight and outerWidth methods +jQuery.each([ "Height", "Width" ], function( i, name ) { + + var type = name.toLowerCase(); + + // innerHeight and innerWidth + jQuery.fn[ "inner" + name ] = function() { + var elem = this[0]; + return elem ? + elem.style ? + parseFloat( jQuery.css( elem, type, "padding" ) ) : + this[ type ]() : + null; + }; + + // outerHeight and outerWidth + jQuery.fn[ "outer" + name ] = function( margin ) { + var elem = this[0]; + return elem ? + elem.style ? + parseFloat( jQuery.css( elem, type, margin ? "margin" : "border" ) ) : + this[ type ]() : + null; + }; + + jQuery.fn[ type ] = function( size ) { + // Get window width or height + var elem = this[0]; + if ( !elem ) { + return size == null ? null : this; + } + + if ( jQuery.isFunction( size ) ) { + return this.each(function( i ) { + var self = jQuery( this ); + self[ type ]( size.call( this, i, self[ type ]() ) ); + }); + } + + if ( jQuery.isWindow( elem ) ) { + // Everyone else use document.documentElement or document.body depending on Quirks vs Standards mode + // 3rd condition allows Nokia support, as it supports the docElem prop but not CSS1Compat + var docElemProp = elem.document.documentElement[ "client" + name ], + body = elem.document.body; + return elem.document.compatMode === "CSS1Compat" && docElemProp || + body && body[ "client" + name ] || docElemProp; + + // Get document width or height + } else if ( elem.nodeType === 9 ) { + // Either scroll[Width/Height] or offset[Width/Height], whichever is greater + return Math.max( + elem.documentElement["client" + name], + elem.body["scroll" + name], elem.documentElement["scroll" + name], + elem.body["offset" + name], elem.documentElement["offset" + name] + ); + + // Get or set width or height on the element + } else if ( size === undefined ) { + var orig = jQuery.css( elem, type ), + ret = parseFloat( orig ); + + return jQuery.isNumeric( ret ) ? ret : orig; + + // Set the width or height on the element (default to pixels if value is unitless) + } else { + return this.css( type, typeof size === "string" ? size : size + "px" ); + } + }; + +}); + + +// Expose jQuery to the global object +window.jQuery = window.$ = jQuery; +})( window ); diff --git a/contrib/libxo/xohtml/external/jquery.qtip.css b/contrib/libxo/xohtml/external/jquery.qtip.css new file mode 100644 index 000000000000..503bd352b152 --- /dev/null +++ b/contrib/libxo/xohtml/external/jquery.qtip.css @@ -0,0 +1,599 @@ +/* + * qTip2 - Pretty powerful tooltips - v2.1.1 + * http://qtip2.com + * + * Copyright (c) 2013 Craig Michael Thompson + * Released under the MIT, GPL licenses + * http://jquery.org/license + * + * Date: Thu Jul 11 2013 02:15 UTC+0000 + * Plugins: tips viewport + * Styles: basic css3 + */ +.qtip{ + position: absolute; + left: -28000px; + top: -28000px; + display: none; + + max-width: 280px; + min-width: 50px; + + font-size: 10.5px; + line-height: 12px; + + direction: ltr; + + box-shadow: none; + padding: 0; +} + + .qtip-content{ + position: relative; + padding: 5px 9px; + overflow: hidden; + + text-align: left; + word-wrap: break-word; + } + + .qtip-titlebar{ + position: relative; + padding: 5px 35px 5px 10px; + overflow: hidden; + + border-width: 0 0 1px; + font-weight: bold; + } + + .qtip-titlebar + .qtip-content{ border-top-width: 0 !important; } + + /* Default close button class */ + .qtip-close{ + position: absolute; + right: -9px; top: -9px; + + cursor: pointer; + outline: medium none; + + border-width: 1px; + border-style: solid; + border-color: transparent; + } + + .qtip-titlebar .qtip-close{ + right: 4px; top: 50%; + margin-top: -9px; + } + + * html .qtip-titlebar .qtip-close{ top: 16px; } /* IE fix */ + + .qtip-titlebar .ui-icon, + .qtip-icon .ui-icon{ + display: block; + text-indent: -1000em; + direction: ltr; + } + + .qtip-icon, .qtip-icon .ui-icon{ + -moz-border-radius: 3px; + -webkit-border-radius: 3px; + border-radius: 3px; + text-decoration: none; + } + + .qtip-icon .ui-icon{ + width: 18px; + height: 14px; + + line-height: 14px; + text-align: center; + text-indent: 0; + font: normal bold 10px/13px Tahoma,sans-serif; + + color: inherit; + background: transparent none no-repeat -100em -100em; + } + +/* Applied to 'focused' tooltips e.g. most recently displayed/interacted with */ +.qtip-focus{} + +/* Applied on hover of tooltips i.e. added/removed on mouseenter/mouseleave respectively */ +.qtip-hover{} + +/* Default tooltip style */ +.qtip-default{ + border-width: 1px; + border-style: solid; + border-color: #F1D031; + + background-color: #FFFFA3; + color: #555; +} + + .qtip-default .qtip-titlebar{ + background-color: #FFEF93; + } + + .qtip-default .qtip-icon{ + border-color: #CCC; + background: #F1F1F1; + color: #777; + } + + .qtip-default .qtip-titlebar .qtip-close{ + border-color: #AAA; + color: #111; + } + + + +/*! Light tooltip style */ +.qtip-light{ + background-color: white; + border-color: #E2E2E2; + color: #454545; +} + + .qtip-light .qtip-titlebar{ + background-color: #f1f1f1; + } + + +/*! Dark tooltip style */ +.qtip-dark{ + background-color: #505050; + border-color: #303030; + color: #f3f3f3; +} + + .qtip-dark .qtip-titlebar{ + background-color: #404040; + } + + .qtip-dark .qtip-icon{ + border-color: #444; + } + + .qtip-dark .qtip-titlebar .ui-state-hover{ + border-color: #303030; + } + + +/*! Cream tooltip style */ +.qtip-cream{ + background-color: #FBF7AA; + border-color: #F9E98E; + color: #A27D35; +} + + .qtip-cream .qtip-titlebar{ + background-color: #F0DE7D; + } + + .qtip-cream .qtip-close .qtip-icon{ + background-position: -82px 0; + } + + +/*! Red tooltip style */ +.qtip-red{ + background-color: #F78B83; + border-color: #D95252; + color: #912323; +} + + .qtip-red .qtip-titlebar{ + background-color: #F06D65; + } + + .qtip-red .qtip-close .qtip-icon{ + background-position: -102px 0; + } + + .qtip-red .qtip-icon{ + border-color: #D95252; + } + + .qtip-red .qtip-titlebar .ui-state-hover{ + border-color: #D95252; + } + + +/*! Green tooltip style */ +.qtip-green{ + background-color: #CAED9E; + border-color: #90D93F; + color: #3F6219; +} + + .qtip-green .qtip-titlebar{ + background-color: #B0DE78; + } + + .qtip-green .qtip-close .qtip-icon{ + background-position: -42px 0; + } + + +/*! Blue tooltip style */ +.qtip-blue{ + background-color: #E5F6FE; + border-color: #ADD9ED; + color: #5E99BD; +} + + .qtip-blue .qtip-titlebar{ + background-color: #D0E9F5; + } + + .qtip-blue .qtip-close .qtip-icon{ + background-position: -2px 0; + } + + + +.qtip-shadow{ + -webkit-box-shadow: 1px 1px 3px 1px rgba(0, 0, 0, 0.15); + -moz-box-shadow: 1px 1px 3px 1px rgba(0, 0, 0, 0.15); + box-shadow: 1px 1px 3px 1px rgba(0, 0, 0, 0.15); +} + +/* Add rounded corners to your tooltips in: FF3+, Chrome 2+, Opera 10.6+, IE9+, Safari 2+ */ +.qtip-rounded, +.qtip-tipsy, +.qtip-bootstrap{ + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; +} + +.qtip-rounded .qtip-titlebar{ + -moz-border-radius: 4px 4px 0 0; + -webkit-border-radius: 4px 4px 0 0; + border-radius: 4px 4px 0 0; +} + +/* Youtube tooltip style */ +.qtip-youtube{ + -moz-border-radius: 2px; + -webkit-border-radius: 2px; + border-radius: 2px; + + -webkit-box-shadow: 0 0 3px #333; + -moz-box-shadow: 0 0 3px #333; + box-shadow: 0 0 3px #333; + + color: white; + border-width: 0; + + background: #4A4A4A; + background-image: -webkit-gradient(linear,left top,left bottom,color-stop(0,#4A4A4A),color-stop(100%,black)); + background-image: -webkit-linear-gradient(top,#4A4A4A 0,black 100%); + background-image: -moz-linear-gradient(top,#4A4A4A 0,black 100%); + background-image: -ms-linear-gradient(top,#4A4A4A 0,black 100%); + background-image: -o-linear-gradient(top,#4A4A4A 0,black 100%); +} + + .qtip-youtube .qtip-titlebar{ + background-color: #4A4A4A; + background-color: rgba(0,0,0,0); + } + + .qtip-youtube .qtip-content{ + padding: .75em; + font: 12px arial,sans-serif; + + filter: progid:DXImageTransform.Microsoft.Gradient(GradientType=0,StartColorStr=#4a4a4a,EndColorStr=#000000); + -ms-filter: "progid:DXImageTransform.Microsoft.Gradient(GradientType=0,StartColorStr=#4a4a4a,EndColorStr=#000000);"; + } + + .qtip-youtube .qtip-icon{ + border-color: #222; + } + + .qtip-youtube .qtip-titlebar .ui-state-hover{ + border-color: #303030; + } + + +/* jQuery TOOLS Tooltip style */ +.qtip-jtools{ + background: #232323; + background: rgba(0, 0, 0, 0.7); + background-image: -webkit-gradient(linear, left top, left bottom, from(#717171), to(#232323)); + background-image: -moz-linear-gradient(top, #717171, #232323); + background-image: -webkit-linear-gradient(top, #717171, #232323); + background-image: -ms-linear-gradient(top, #717171, #232323); + background-image: -o-linear-gradient(top, #717171, #232323); + + border: 2px solid #ddd; + border: 2px solid rgba(241,241,241,1); + + -moz-border-radius: 2px; + -webkit-border-radius: 2px; + border-radius: 2px; + + -webkit-box-shadow: 0 0 12px #333; + -moz-box-shadow: 0 0 12px #333; + box-shadow: 0 0 12px #333; +} + + /* IE Specific */ + .qtip-jtools .qtip-titlebar{ + background-color: transparent; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr=#717171,endColorstr=#4A4A4A); + -ms-filter: "progid:DXImageTransform.Microsoft.gradient(startColorstr=#717171,endColorstr=#4A4A4A)"; + } + .qtip-jtools .qtip-content{ + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr=#4A4A4A,endColorstr=#232323); + -ms-filter: "progid:DXImageTransform.Microsoft.gradient(startColorstr=#4A4A4A,endColorstr=#232323)"; + } + + .qtip-jtools .qtip-titlebar, + .qtip-jtools .qtip-content{ + background: transparent; + color: white; + border: 0 dashed transparent; + } + + .qtip-jtools .qtip-icon{ + border-color: #555; + } + + .qtip-jtools .qtip-titlebar .ui-state-hover{ + border-color: #333; + } + + +/* Cluetip style */ +.qtip-cluetip{ + -webkit-box-shadow: 4px 4px 5px rgba(0, 0, 0, 0.4); + -moz-box-shadow: 4px 4px 5px rgba(0, 0, 0, 0.4); + box-shadow: 4px 4px 5px rgba(0, 0, 0, 0.4); + + background-color: #D9D9C2; + color: #111; + border: 0 dashed transparent; +} + + .qtip-cluetip .qtip-titlebar{ + background-color: #87876A; + color: white; + border: 0 dashed transparent; + } + + .qtip-cluetip .qtip-icon{ + border-color: #808064; + } + + .qtip-cluetip .qtip-titlebar .ui-state-hover{ + border-color: #696952; + color: #696952; + } + + +/* Tipsy style */ +.qtip-tipsy{ + background: black; + background: rgba(0, 0, 0, .87); + + color: white; + border: 0 solid transparent; + + font-size: 11px; + font-family: 'Lucida Grande', sans-serif; + font-weight: bold; + line-height: 16px; + text-shadow: 0 1px black; +} + + .qtip-tipsy .qtip-titlebar{ + padding: 6px 35px 0 10px; + background-color: transparent; + } + + .qtip-tipsy .qtip-content{ + padding: 6px 10px; + } + + .qtip-tipsy .qtip-icon{ + border-color: #222; + text-shadow: none; + } + + .qtip-tipsy .qtip-titlebar .ui-state-hover{ + border-color: #303030; + } + + +/* Tipped style */ +.qtip-tipped{ + border: 3px solid #959FA9; + + -moz-border-radius: 3px; + -webkit-border-radius: 3px; + border-radius: 3px; + + background-color: #F9F9F9; + color: #454545; + + font-weight: normal; + font-family: serif; + + font-size: 12px; +} + + .qtip-tipped .qtip-titlebar{ + border-bottom-width: 0; + + color: white; + background: #3A79B8; + background-image: -webkit-gradient(linear, left top, left bottom, from(#3A79B8), to(#2E629D)); + background-image: -webkit-linear-gradient(top, #3A79B8, #2E629D); + background-image: -moz-linear-gradient(top, #3A79B8, #2E629D); + background-image: -ms-linear-gradient(top, #3A79B8, #2E629D); + background-image: -o-linear-gradient(top, #3A79B8, #2E629D); + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr=#3A79B8,endColorstr=#2E629D); + -ms-filter: "progid:DXImageTransform.Microsoft.gradient(startColorstr=#3A79B8,endColorstr=#2E629D)"; + + font-size: 14px; + } + + .qtip-tipped .qtip-icon{ + border: 2px solid #285589; + background: #285589; + } + + .qtip-tipped .qtip-icon .ui-icon{ + background-color: #FBFBFB; + color: #555; + } + + +/** + * Twitter Bootstrap style. + * + * Tested with IE 8, IE 9, Chrome 18, Firefox 9, Opera 11. + * Does not work with IE 7. + */ +.qtip-bootstrap{ + /** Taken from Bootstrap body */ + font-size: 14px; + line-height: 20px; + color: #333333; + + /** Taken from Bootstrap .popover */ + padding: 1px; + background-color: #ffffff; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.2); + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; + -webkit-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + -moz-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + -webkit-background-clip: padding-box; + -moz-background-clip: padding; + background-clip: padding-box; +} + + .qtip-bootstrap .qtip-titlebar{ + /** Taken from Bootstrap .popover-title */ + padding: 8px 14px; + margin: 0; + font-size: 14px; + font-weight: normal; + line-height: 18px; + background-color: #f7f7f7; + border-bottom: 1px solid #ebebeb; + -webkit-border-radius: 5px 5px 0 0; + -moz-border-radius: 5px 5px 0 0; + border-radius: 5px 5px 0 0; + } + + .qtip-bootstrap .qtip-titlebar .qtip-close{ + /** + * Overrides qTip2: + * .qtip-titlebar .qtip-close{ + * [...] + * right: 4px; + * top: 50%; + * [...] + * border-style: solid; + * } + */ + right: 11px; + top: 45%; + border-style: none; + } + + .qtip-bootstrap .qtip-content{ + /** Taken from Bootstrap .popover-content */ + padding: 9px 14px; + } + + .qtip-bootstrap .qtip-icon{ + /** + * Overrides qTip2: + * .qtip-default .qtip-icon { + * border-color: #CCC; + * background: #F1F1F1; + * color: #777; + * } + */ + background: transparent; + } + + .qtip-bootstrap .qtip-icon .ui-icon{ + /** + * Overrides qTip2: + * .qtip-icon .ui-icon{ + * width: 18px; + * height: 14px; + * } + */ + width: auto; + height: auto; + + /* Taken from Bootstrap .close */ + float: right; + font-size: 20px; + font-weight: bold; + line-height: 18px; + color: #000000; + text-shadow: 0 1px 0 #ffffff; + opacity: 0.2; + filter: alpha(opacity=20); + } + + .qtip-bootstrap .qtip-icon .ui-icon:hover{ + /* Taken from Bootstrap .close:hover */ + color: #000000; + text-decoration: none; + cursor: pointer; + opacity: 0.4; + filter: alpha(opacity=40); + } + + +/* IE9 fix - removes all filters */ +.qtip:not(.ie9haxors) div.qtip-content, +.qtip:not(.ie9haxors) div.qtip-titlebar{ + filter: none; + -ms-filter: none; +} + + + +.qtip .qtip-tip{ + margin: 0 auto; + overflow: hidden; + z-index: 10; + +} + + /* Opera bug #357 - Incorrect tip position + https://github.com/Craga89/qTip2/issues/367 */ + x:-o-prefocus, .qtip .qtip-tip{ + visibility: hidden; + } + + .qtip .qtip-tip, + .qtip .qtip-tip .qtip-vml, + .qtip .qtip-tip canvas{ + position: absolute; + + color: #123456; + background: transparent; + border: 0 dashed transparent; + } + + .qtip .qtip-tip canvas{ top: 0; left: 0; } + + .qtip .qtip-tip .qtip-vml{ + behavior: url(#default#VML); + display: inline-block; + visibility: visible; + } diff --git a/contrib/libxo/xohtml/external/jquery.qtip.js b/contrib/libxo/xohtml/external/jquery.qtip.js new file mode 100644 index 000000000000..1159b4e1b867 --- /dev/null +++ b/contrib/libxo/xohtml/external/jquery.qtip.js @@ -0,0 +1,2656 @@ +/* + * qTip2 - Pretty powerful tooltips - v2.1.1 + * http://qtip2.com + * + * Copyright (c) 2013 Craig Michael Thompson + * Released under the MIT, GPL licenses + * http://jquery.org/license + * + * Date: Thu Jul 11 2013 02:15 UTC+0000 + * Plugins: tips viewport + * Styles: basic css3 + */ +/*global window: false, jQuery: false, console: false, define: false */ + +/* Cache window, document, undefined */ +(function( window, document, undefined ) { + +// Uses AMD or browser globals to create a jQuery plugin. +(function( factory ) { + "use strict"; + if(typeof define === 'function' && define.amd) { + define(['jquery', 'imagesloaded'], factory); + } + else if(jQuery && !jQuery.fn.qtip) { + factory(jQuery); + } +} +(function($) { + /* This currently causes issues with Safari 6, so for it's disabled */ + //"use strict"; // (Dis)able ECMAScript "strict" operation for this function. See more: http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/ + +;// Munge the primitives - Paul Irish tip +var TRUE = true, +FALSE = false, +NULL = null, + +// Common variables +X = 'x', Y = 'y', +WIDTH = 'width', +HEIGHT = 'height', + +// Positioning sides +TOP = 'top', +LEFT = 'left', +BOTTOM = 'bottom', +RIGHT = 'right', +CENTER = 'center', + +// Position adjustment types +FLIP = 'flip', +FLIPINVERT = 'flipinvert', +SHIFT = 'shift', + +// Shortcut vars +QTIP, PROTOTYPE, CORNER, CHECKS, +PLUGINS = {}, +NAMESPACE = 'qtip', +ATTR_HAS = 'data-hasqtip', +ATTR_ID = 'data-qtip-id', +WIDGET = ['ui-widget', 'ui-tooltip'], +SELECTOR = '.'+NAMESPACE, +INACTIVE_EVENTS = 'click dblclick mousedown mouseup mousemove mouseleave mouseenter'.split(' '), + +CLASS_FIXED = NAMESPACE+'-fixed', +CLASS_DEFAULT = NAMESPACE + '-default', +CLASS_FOCUS = NAMESPACE + '-focus', +CLASS_HOVER = NAMESPACE + '-hover', +CLASS_DISABLED = NAMESPACE+'-disabled', + +replaceSuffix = '_replacedByqTip', +oldtitle = 'oldtitle', +trackingBound; + +// Browser detection +BROWSER = { + /* + * IE version detection + * + * Adapted from: http://ajaxian.com/archives/attack-of-the-ie-conditional-comment + * Credit to James Padolsey for the original implemntation! + */ + ie: (function(){ + var v = 3, div = document.createElement('div'); + while ((div.innerHTML = '<!--[if gt IE '+(++v)+']><i></i><![endif]-->')) { + if(!div.getElementsByTagName('i')[0]) { break; } + } + return v > 4 ? v : NaN; + }()), + + /* + * iOS version detection + */ + iOS: parseFloat( + ('' + (/CPU.*OS ([0-9_]{1,5})|(CPU like).*AppleWebKit.*Mobile/i.exec(navigator.userAgent) || [0,''])[1]) + .replace('undefined', '3_2').replace('_', '.').replace('_', '') + ) || FALSE +}; + +;function QTip(target, options, id, attr) {
+ // Elements and ID
+ this.id = id;
+ this.target = target;
+ this.tooltip = NULL;
+ this.elements = elements = { target: target };
+
+ // Internal constructs
+ this._id = NAMESPACE + '-' + id;
+ this.timers = { img: {} };
+ this.options = options;
+ this.plugins = {};
+
+ // Cache object
+ this.cache = cache = {
+ event: {},
+ target: $(),
+ disabled: FALSE,
+ attr: attr,
+ onTooltip: FALSE,
+ lastClass: ''
+ };
+
+ // Set the initial flags
+ this.rendered = this.destroyed = this.disabled = this.waiting =
+ this.hiddenDuringWait = this.positioning = this.triggering = FALSE;
+}
+PROTOTYPE = QTip.prototype;
+
+PROTOTYPE.render = function(show) {
+ if(this.rendered || this.destroyed) { return this; } // If tooltip has already been rendered, exit
+
+ var self = this,
+ options = this.options,
+ cache = this.cache,
+ elements = this.elements,
+ text = options.content.text,
+ title = options.content.title,
+ button = options.content.button,
+ posOptions = options.position,
+ namespace = '.'+this._id+' ',
+ deferreds = [];
+
+ // Add ARIA attributes to target
+ $.attr(this.target[0], 'aria-describedby', this._id);
+
+ // Create tooltip element
+ this.tooltip = elements.tooltip = tooltip = $('<div/>', {
+ 'id': this._id,
+ 'class': [ NAMESPACE, CLASS_DEFAULT, options.style.classes, NAMESPACE + '-pos-' + options.position.my.abbrev() ].join(' '),
+ 'width': options.style.width || '',
+ 'height': options.style.height || '',
+ 'tracking': posOptions.target === 'mouse' && posOptions.adjust.mouse,
+
+ /* ARIA specific attributes */
+ 'role': 'alert',
+ 'aria-live': 'polite',
+ 'aria-atomic': FALSE,
+ 'aria-describedby': this._id + '-content',
+ 'aria-hidden': TRUE
+ })
+ .toggleClass(CLASS_DISABLED, this.disabled)
+ .attr(ATTR_ID, this.id)
+ .data(NAMESPACE, this)
+ .appendTo(posOptions.container)
+ .append(
+ // Create content element
+ elements.content = $('<div />', {
+ 'class': NAMESPACE + '-content',
+ 'id': this._id + '-content',
+ 'aria-atomic': TRUE
+ })
+ );
+
+ // Set rendered flag and prevent redundant reposition calls for now
+ this.rendered = -1;
+ this.positioning = TRUE;
+
+ // Create title...
+ if(title) {
+ this._createTitle();
+
+ // Update title only if its not a callback (called in toggle if so)
+ if(!$.isFunction(title)) {
+ deferreds.push( this._updateTitle(title, FALSE) );
+ }
+ }
+
+ // Create button
+ if(button) { this._createButton(); }
+
+ // Set proper rendered flag and update content if not a callback function (called in toggle)
+ if(!$.isFunction(text)) {
+ deferreds.push( this._updateContent(text, FALSE) );
+ }
+ this.rendered = TRUE;
+
+ // Setup widget classes
+ this._setWidget();
+
+ // Assign passed event callbacks (before plugins!)
+ $.each(options.events, function(name, callback) {
+ $.isFunction(callback) && tooltip.bind(
+ (name === 'toggle' ? ['tooltipshow','tooltiphide'] : ['tooltip'+name])
+ .join(namespace)+namespace, callback
+ );
+ });
+
+ // Initialize 'render' plugins
+ $.each(PLUGINS, function(name) {
+ var instance;
+ if(this.initialize === 'render' && (instance = this(self))) {
+ self.plugins[name] = instance;
+ }
+ });
+
+ // Assign events
+ this._assignEvents();
+
+ // When deferreds have completed
+ $.when.apply($, deferreds).then(function() {
+ // tooltiprender event
+ self._trigger('render');
+
+ // Reset flags
+ self.positioning = FALSE;
+
+ // Show tooltip if not hidden during wait period
+ if(!self.hiddenDuringWait && (options.show.ready || show)) {
+ self.toggle(TRUE, cache.event, FALSE);
+ }
+ self.hiddenDuringWait = FALSE;
+ });
+
+ // Expose API
+ QTIP.api[this.id] = this;
+
+ return this;
+};
+
+PROTOTYPE.destroy = function(immediate) {
+ // Set flag the signify destroy is taking place to plugins
+ // and ensure it only gets destroyed once!
+ if(this.destroyed) { return this.target; }
+
+ function process() {
+ if(this.destroyed) { return; }
+ this.destroyed = TRUE;
+
+ var target = this.target,
+ title = target.attr(oldtitle);
+
+ // Destroy tooltip if rendered
+ if(this.rendered) {
+ this.tooltip.stop(1,0).find('*').remove().end().remove();
+ }
+
+ // Destroy all plugins
+ $.each(this.plugins, function(name) {
+ this.destroy && this.destroy();
+ });
+
+ // Clear timers and remove bound events
+ clearTimeout(this.timers.show);
+ clearTimeout(this.timers.hide);
+ this._unassignEvents();
+
+ // Remove api object and ARIA attributes
+ target.removeData(NAMESPACE).removeAttr(ATTR_ID)
+ .removeAttr('aria-describedby');
+
+ // Reset old title attribute if removed
+ if(this.options.suppress && title) {
+ target.attr('title', title).removeAttr(oldtitle);
+ }
+
+ // Remove qTip events associated with this API
+ this._unbind(target);
+
+ // Remove ID from used id objects, and delete object references
+ // for better garbage collection and leak protection
+ this.options = this.elements = this.cache = this.timers =
+ this.plugins = this.mouse = NULL;
+
+ // Delete epoxsed API object
+ delete QTIP.api[this.id];
+ }
+
+ // If an immediate destory is needed
+ if(immediate !== TRUE && this.rendered) {
+ tooltip.one('tooltiphidden', $.proxy(process, this));
+ !this.triggering && this.hide();
+ }
+
+ // If we're not in the process of hiding... process
+ else { process.call(this); }
+
+ return this.target;
+};
+
+;function invalidOpt(a) { + return a === NULL || $.type(a) !== 'object'; +} + +function invalidContent(c) { + return !( $.isFunction(c) || (c && c.attr) || c.length || ($.type(c) === 'object' && (c.jquery || c.then) )); +} + +// Option object sanitizer +function sanitizeOptions(opts) { + var content, text, ajax, once; + + if(invalidOpt(opts)) { return FALSE; } + + if(invalidOpt(opts.metadata)) { + opts.metadata = { type: opts.metadata }; + } + + if('content' in opts) { + content = opts.content; + + if(invalidOpt(content) || content.jquery || content.done) { + content = opts.content = { + text: (text = invalidContent(content) ? FALSE : content) + }; + } + else { text = content.text; } + + // DEPRECATED - Old content.ajax plugin functionality + // Converts it into the proper Deferred syntax + if('ajax' in content) { + ajax = content.ajax; + once = ajax && ajax.once !== FALSE; + delete content.ajax; + + content.text = function(event, api) { + var loading = text || $(this).attr(api.options.content.attr) || 'Loading...', + + deferred = $.ajax( + $.extend({}, ajax, { context: api }) + ) + .then(ajax.success, NULL, ajax.error) + .then(function(content) { + if(content && once) { api.set('content.text', content); } + return content; + }, + function(xhr, status, error) { + if(api.destroyed || xhr.status === 0) { return; } + api.set('content.text', status + ': ' + error); + }); + + return !once ? (api.set('content.text', loading), deferred) : loading; + }; + } + + if('title' in content) { + if(!invalidOpt(content.title)) { + content.button = content.title.button; + content.title = content.title.text; + } + + if(invalidContent(content.title || FALSE)) { + content.title = FALSE; + } + } + } + + if('position' in opts && invalidOpt(opts.position)) { + opts.position = { my: opts.position, at: opts.position }; + } + + if('show' in opts && invalidOpt(opts.show)) { + opts.show = opts.show.jquery ? { target: opts.show } : + opts.show === TRUE ? { ready: TRUE } : { event: opts.show }; + } + + if('hide' in opts && invalidOpt(opts.hide)) { + opts.hide = opts.hide.jquery ? { target: opts.hide } : { event: opts.hide }; + } + + if('style' in opts && invalidOpt(opts.style)) { + opts.style = { classes: opts.style }; + } + + // Sanitize plugin options + $.each(PLUGINS, function() { + this.sanitize && this.sanitize(opts); + }); + + return opts; +} + +// Setup builtin .set() option checks +CHECKS = PROTOTYPE.checks = { + builtin: { + // Core checks + '^id$': function(obj, o, v, prev) { + var id = v === TRUE ? QTIP.nextid : v, + new_id = NAMESPACE + '-' + id; + + if(id !== FALSE && id.length > 0 && !$('#'+new_id).length) { + this._id = new_id; + + if(this.rendered) { + this.tooltip[0].id = this._id; + this.elements.content[0].id = this._id + '-content'; + this.elements.title[0].id = this._id + '-title'; + } + } + else { obj[o] = prev; } + }, + '^prerender': function(obj, o, v) { + v && !this.rendered && this.render(this.options.show.ready); + }, + + // Content checks + '^content.text$': function(obj, o, v) { + this._updateContent(v); + }, + '^content.attr$': function(obj, o, v, prev) { + if(this.options.content.text === this.target.attr(prev)) { + this._updateContent( this.target.attr(v) ); + } + }, + '^content.title$': function(obj, o, v) { + // Remove title if content is null + if(!v) { return this._removeTitle(); } + + // If title isn't already created, create it now and update + v && !this.elements.title && this._createTitle(); + this._updateTitle(v); + }, + '^content.button$': function(obj, o, v) { + this._updateButton(v); + }, + '^content.title.(text|button)$': function(obj, o, v) { + this.set('content.'+o, v); // Backwards title.text/button compat + }, + + // Position checks + '^position.(my|at)$': function(obj, o, v){ + 'string' === typeof v && (obj[o] = new CORNER(v, o === 'at')); + }, + '^position.container$': function(obj, o, v){ + this.tooltip.appendTo(v); + }, + + // Show checks + '^show.ready$': function(obj, o, v) { + v && (!this.rendered && this.render(TRUE) || this.toggle(TRUE)); + }, + + // Style checks + '^style.classes$': function(obj, o, v, p) { + this.tooltip.removeClass(p).addClass(v); + }, + '^style.width|height': function(obj, o, v) { + this.tooltip.css(o, v); + }, + '^style.widget|content.title': function() { + this._setWidget(); + }, + '^style.def': function(obj, o, v) { + this.tooltip.toggleClass(CLASS_DEFAULT, !!v); + }, + + // Events check + '^events.(render|show|move|hide|focus|blur)$': function(obj, o, v) { + tooltip[($.isFunction(v) ? '' : 'un') + 'bind']('tooltip'+o, v); + }, + + // Properties which require event reassignment + '^(show|hide|position).(event|target|fixed|inactive|leave|distance|viewport|adjust)': function() { + var posOptions = this.options.position; + + // Set tracking flag + tooltip.attr('tracking', posOptions.target === 'mouse' && posOptions.adjust.mouse); + + // Reassign events + this._unassignEvents(); + this._assignEvents(); + } + } +}; + +// Dot notation converter +function convertNotation(options, notation) { + var i = 0, obj, option = options, + + // Split notation into array + levels = notation.split('.'); + + // Loop through + while( option = option[ levels[i++] ] ) { + if(i < levels.length) { obj = option; } + } + + return [obj || options, levels.pop()]; +} + +PROTOTYPE.get = function(notation) { + if(this.destroyed) { return this; } + + var o = convertNotation(this.options, notation.toLowerCase()), + result = o[0][ o[1] ]; + + return result.precedance ? result.string() : result; +}; + +function setCallback(notation, args) { + var category, rule, match; + + for(category in this.checks) { + for(rule in this.checks[category]) { + if(match = (new RegExp(rule, 'i')).exec(notation)) { + args.push(match); + + if(category === 'builtin' || this.plugins[category]) { + this.checks[category][rule].apply( + this.plugins[category] || this, args + ); + } + } + } + } +} + +var rmove = /^position\.(my|at|adjust|target|container|viewport)|style|content|show\.ready/i, + rrender = /^prerender|show\.ready/i; + +PROTOTYPE.set = function(option, value) { + if(this.destroyed) { return this; } + + var rendered = this.rendered, + reposition = FALSE, + options = this.options, + checks = this.checks, + name; + + // Convert singular option/value pair into object form + if('string' === typeof option) { + name = option; option = {}; option[name] = value; + } + else { option = $.extend({}, option); } + + // Set all of the defined options to their new values + $.each(option, function(notation, value) { + if(!rendered && !rrender.test(notation)) { + delete option[notation]; return; + } + + // Set new obj value + var obj = convertNotation(options, notation.toLowerCase()), previous; + previous = obj[0][ obj[1] ]; + obj[0][ obj[1] ] = value && value.nodeType ? $(value) : value; + + // Also check if we need to reposition + reposition = rmove.test(notation) || reposition; + + // Set the new params for the callback + option[notation] = [obj[0], obj[1], value, previous]; + }); + + // Re-sanitize options + sanitizeOptions(options); + + /* + * Execute any valid callbacks for the set options + * Also set positioning flag so we don't get loads of redundant repositioning calls. + */ + this.positioning = TRUE; + $.each(option, $.proxy(setCallback, this)); + this.positioning = FALSE; + + // Update position if needed + if(this.rendered && this.tooltip[0].offsetWidth > 0 && reposition) { + this.reposition( options.position.target === 'mouse' ? NULL : this.cache.event ); + } + + return this; +}; + +;PROTOTYPE._update = function(content, element, reposition) { + var self = this, + cache = this.cache; + + // Make sure tooltip is rendered and content is defined. If not return + if(!this.rendered || !content) { return FALSE; } + + // Use function to parse content + if($.isFunction(content)) { + content = content.call(this.elements.target, cache.event, this) || ''; + } + + // Handle deferred content + if($.isFunction(content.then)) { + cache.waiting = TRUE; + return content.then(function(c) { + cache.waiting = FALSE; + return self._update(c, element); + }, NULL, function(e) { + return self._update(e, element); + }); + } + + // If content is null... return false + if(content === FALSE || (!content && content !== '')) { return FALSE; } + + // Append new content if its a DOM array and show it if hidden + if(content.jquery && content.length > 0) { + element.children().detach().end().append( content.css({ display: 'block' }) ); + } + + // Content is a regular string, insert the new content + else { element.html(content); } + + // If imagesLoaded is included, ensure images have loaded and return promise + cache.waiting = TRUE; + + return ( $.fn.imagesLoaded ? element.imagesLoaded() : $.Deferred().resolve($([])) ) + .done(function(images) { + cache.waiting = FALSE; + + // Reposition if rendered + if(images.length && self.rendered && self.tooltip[0].offsetWidth > 0) { + self.reposition(cache.event, !images.length); + } + }) + .promise(); +}; + +PROTOTYPE._updateContent = function(content, reposition) { + this._update(content, this.elements.content, reposition); +}; + +PROTOTYPE._updateTitle = function(content, reposition) { + if(this._update(content, this.elements.title, reposition) === FALSE) { + this._removeTitle(FALSE); + } +}; + +PROTOTYPE._createTitle = function() +{ + var elements = this.elements, + id = this._id+'-title'; + + // Destroy previous title element, if present + if(elements.titlebar) { this._removeTitle(); } + + // Create title bar and title elements + elements.titlebar = $('<div />', { + 'class': NAMESPACE + '-titlebar ' + (this.options.style.widget ? createWidgetClass('header') : '') + }) + .append( + elements.title = $('<div />', { + 'id': id, + 'class': NAMESPACE + '-title', + 'aria-atomic': TRUE + }) + ) + .insertBefore(elements.content) + + // Button-specific events + .delegate('.qtip-close', 'mousedown keydown mouseup keyup mouseout', function(event) { + $(this).toggleClass('ui-state-active ui-state-focus', event.type.substr(-4) === 'down'); + }) + .delegate('.qtip-close', 'mouseover mouseout', function(event){ + $(this).toggleClass('ui-state-hover', event.type === 'mouseover'); + }); + + // Create button if enabled + if(this.options.content.button) { this._createButton(); } +}; + +PROTOTYPE._removeTitle = function(reposition) +{ + var elements = this.elements; + + if(elements.title) { + elements.titlebar.remove(); + elements.titlebar = elements.title = elements.button = NULL; + + // Reposition if enabled + if(reposition !== FALSE) { this.reposition(); } + } +}; + +;PROTOTYPE.reposition = function(event, effect) { + if(!this.rendered || this.positioning || this.destroyed) { return this; } + + // Set positioning flag + this.positioning = TRUE; + + var cache = this.cache, + tooltip = this.tooltip, + posOptions = this.options.position, + target = posOptions.target, + my = posOptions.my, + at = posOptions.at, + viewport = posOptions.viewport, + container = posOptions.container, + adjust = posOptions.adjust, + method = adjust.method.split(' '), + elemWidth = tooltip.outerWidth(FALSE), + elemHeight = tooltip.outerHeight(FALSE), + targetWidth = 0, + targetHeight = 0, + type = tooltip.css('position'), + position = { left: 0, top: 0 }, + visible = tooltip[0].offsetWidth > 0, + isScroll = event && event.type === 'scroll', + win = $(window), + doc = container[0].ownerDocument, + mouse = this.mouse, + pluginCalculations, offset; + + // Check if absolute position was passed + if($.isArray(target) && target.length === 2) { + // Force left top and set position + at = { x: LEFT, y: TOP }; + position = { left: target[0], top: target[1] }; + } + + // Check if mouse was the target + else if(target === 'mouse' && ((event && event.pageX) || cache.event.pageX)) { + // Force left top to allow flipping + at = { x: LEFT, y: TOP }; + + // Use cached event if one isn't available for positioning + event = mouse && mouse.pageX && (adjust.mouse || !event || !event.pageX) ? mouse : + (event && (event.type === 'resize' || event.type === 'scroll') ? cache.event : + event && event.pageX && event.type === 'mousemove' ? event : + (!adjust.mouse || this.options.show.distance) && cache.origin && cache.origin.pageX ? cache.origin : + event) || event || cache.event || mouse || {}; + + // Calculate body and container offset and take them into account below + if(type !== 'static') { position = container.offset(); } + if(doc.body.offsetWidth !== (window.innerWidth || doc.documentElement.clientWidth)) { offset = $(doc.body).offset(); } + + // Use event coordinates for position + position = { + left: event.pageX - position.left + (offset && offset.left || 0), + top: event.pageY - position.top + (offset && offset.top || 0) + }; + + // Scroll events are a pain, some browsers + if(adjust.mouse && isScroll) { + position.left -= mouse.scrollX - win.scrollLeft(); + position.top -= mouse.scrollY - win.scrollTop(); + } + } + + // Target wasn't mouse or absolute... + else { + // Check if event targetting is being used + if(target === 'event' && event && event.target && event.type !== 'scroll' && event.type !== 'resize') { + cache.target = $(event.target); + } + else if(target !== 'event'){ + cache.target = $(target.jquery ? target : elements.target); + } + target = cache.target; + + // Parse the target into a jQuery object and make sure there's an element present + target = $(target).eq(0); + if(target.length === 0) { return this; } + + // Check if window or document is the target + else if(target[0] === document || target[0] === window) { + targetWidth = BROWSER.iOS ? window.innerWidth : target.width(); + targetHeight = BROWSER.iOS ? window.innerHeight : target.height(); + + if(target[0] === window) { + position = { + top: (viewport || target).scrollTop(), + left: (viewport || target).scrollLeft() + }; + } + } + + // Check if the target is an <AREA> element + else if(PLUGINS.imagemap && target.is('area')) { + pluginCalculations = PLUGINS.imagemap(this, target, at, PLUGINS.viewport ? method : FALSE); + } + + // Check if the target is an SVG element + else if(PLUGINS.svg && target[0].ownerSVGElement) { + pluginCalculations = PLUGINS.svg(this, target, at, PLUGINS.viewport ? method : FALSE); + } + + // Otherwise use regular jQuery methods + else { + targetWidth = target.outerWidth(FALSE); + targetHeight = target.outerHeight(FALSE); + position = target.offset(); + } + + // Parse returned plugin values into proper variables + if(pluginCalculations) { + targetWidth = pluginCalculations.width; + targetHeight = pluginCalculations.height; + offset = pluginCalculations.offset; + position = pluginCalculations.position; + } + + // Adjust position to take into account offset parents + position = this.reposition.offset(target, position, container); + + // Adjust for position.fixed tooltips (and also iOS scroll bug in v3.2-4.0 & v4.3-4.3.2) + if((BROWSER.iOS > 3.1 && BROWSER.iOS < 4.1) || + (BROWSER.iOS >= 4.3 && BROWSER.iOS < 4.33) || + (!BROWSER.iOS && type === 'fixed') + ){ + position.left -= win.scrollLeft(); + position.top -= win.scrollTop(); + } + + // Adjust position relative to target + if(!pluginCalculations || (pluginCalculations && pluginCalculations.adjustable !== FALSE)) { + position.left += at.x === RIGHT ? targetWidth : at.x === CENTER ? targetWidth / 2 : 0; + position.top += at.y === BOTTOM ? targetHeight : at.y === CENTER ? targetHeight / 2 : 0; + } + } + + // Adjust position relative to tooltip + position.left += adjust.x + (my.x === RIGHT ? -elemWidth : my.x === CENTER ? -elemWidth / 2 : 0); + position.top += adjust.y + (my.y === BOTTOM ? -elemHeight : my.y === CENTER ? -elemHeight / 2 : 0); + + // Use viewport adjustment plugin if enabled + if(PLUGINS.viewport) { + position.adjusted = PLUGINS.viewport( + this, position, posOptions, targetWidth, targetHeight, elemWidth, elemHeight + ); + + // Apply offsets supplied by positioning plugin (if used) + if(offset && position.adjusted.left) { position.left += offset.left; } + if(offset && position.adjusted.top) { position.top += offset.top; } + } + + // Viewport adjustment is disabled, set values to zero + else { position.adjusted = { left: 0, top: 0 }; } + + // tooltipmove event + if(!this._trigger('move', [position, viewport.elem || viewport], event)) { return this; } + delete position.adjusted; + + // If effect is disabled, target it mouse, no animation is defined or positioning gives NaN out, set CSS directly + if(effect === FALSE || !visible || isNaN(position.left) || isNaN(position.top) || target === 'mouse' || !$.isFunction(posOptions.effect)) { + tooltip.css(position); + } + + // Use custom function if provided + else if($.isFunction(posOptions.effect)) { + posOptions.effect.call(tooltip, this, $.extend({}, position)); + tooltip.queue(function(next) { + // Reset attributes to avoid cross-browser rendering bugs + $(this).css({ opacity: '', height: '' }); + if(BROWSER.ie) { this.style.removeAttribute('filter'); } + + next(); + }); + } + + // Set positioning flag + this.positioning = FALSE; + + return this; +}; + +// Custom (more correct for qTip!) offset calculator +PROTOTYPE.reposition.offset = function(elem, pos, container) { + if(!container[0]) { return pos; } + + var ownerDocument = $(elem[0].ownerDocument), + quirks = !!BROWSER.ie && document.compatMode !== 'CSS1Compat', + parent = container[0], + scrolled, position, parentOffset, overflow; + + function scroll(e, i) { + pos.left += i * e.scrollLeft(); + pos.top += i * e.scrollTop(); + } + + // Compensate for non-static containers offset + do { + if((position = $.css(parent, 'position')) !== 'static') { + if(position === 'fixed') { + parentOffset = parent.getBoundingClientRect(); + scroll(ownerDocument, -1); + } + else { + parentOffset = $(parent).position(); + parentOffset.left += (parseFloat($.css(parent, 'borderLeftWidth')) || 0); + parentOffset.top += (parseFloat($.css(parent, 'borderTopWidth')) || 0); + } + + pos.left -= parentOffset.left + (parseFloat($.css(parent, 'marginLeft')) || 0); + pos.top -= parentOffset.top + (parseFloat($.css(parent, 'marginTop')) || 0); + + // If this is the first parent element with an overflow of "scroll" or "auto", store it + if(!scrolled && (overflow = $.css(parent, 'overflow')) !== 'hidden' && overflow !== 'visible') { scrolled = $(parent); } + } + } + while((parent = parent.offsetParent)); + + // Compensate for containers scroll if it also has an offsetParent (or in IE quirks mode) + if(scrolled && (scrolled[0] !== ownerDocument[0] || quirks)) { + scroll(scrolled, 1); + } + + return pos; +}; + +// Corner class +var C = (CORNER = PROTOTYPE.reposition.Corner = function(corner, forceY) { + corner = ('' + corner).replace(/([A-Z])/, ' $1').replace(/middle/gi, CENTER).toLowerCase(); + this.x = (corner.match(/left|right/i) || corner.match(/center/) || ['inherit'])[0].toLowerCase(); + this.y = (corner.match(/top|bottom|center/i) || ['inherit'])[0].toLowerCase(); + this.forceY = !!forceY; + + var f = corner.charAt(0); + this.precedance = (f === 't' || f === 'b' ? Y : X); +}).prototype; + +C.invert = function(z, center) { + this[z] = this[z] === LEFT ? RIGHT : this[z] === RIGHT ? LEFT : center || this[z]; +}; + +C.string = function() { + var x = this.x, y = this.y; + return x === y ? x : this.precedance === Y || (this.forceY && y !== 'center') ? y+' '+x : x+' '+y; +}; + +C.abbrev = function() { + var result = this.string().split(' '); + return result[0].charAt(0) + (result[1] && result[1].charAt(0) || ''); +}; + +C.clone = function() { + return new CORNER( this.string(), this.forceY ); +};; +PROTOTYPE.toggle = function(state, event) { + var cache = this.cache, + options = this.options, + tooltip = this.tooltip; + + // Try to prevent flickering when tooltip overlaps show element + if(event) { + if((/over|enter/).test(event.type) && (/out|leave/).test(cache.event.type) && + options.show.target.add(event.target).length === options.show.target.length && + tooltip.has(event.relatedTarget).length) { + return this; + } + + // Cache event + cache.event = $.extend({}, event); + } + + // If we're currently waiting and we've just hidden... stop it + this.waiting && !state && (this.hiddenDuringWait = TRUE); + + // Render the tooltip if showing and it isn't already + if(!this.rendered) { return state ? this.render(1) : this; } + else if(this.destroyed || this.disabled) { return this; } + + var type = state ? 'show' : 'hide', + opts = this.options[type], + otherOpts = this.options[ !state ? 'show' : 'hide' ], + posOptions = this.options.position, + contentOptions = this.options.content, + width = this.tooltip.css('width'), + visible = this.tooltip[0].offsetWidth > 0, + animate = state || opts.target.length === 1, + sameTarget = !event || opts.target.length < 2 || cache.target[0] === event.target, + identicalState, allow, showEvent, delay; + + // Detect state if valid one isn't provided + if((typeof state).search('boolean|number')) { state = !visible; } + + // Check if the tooltip is in an identical state to the new would-be state + identicalState = !tooltip.is(':animated') && visible === state && sameTarget; + + // Fire tooltip(show/hide) event and check if destroyed + allow = !identicalState ? !!this._trigger(type, [90]) : NULL; + + // If the user didn't stop the method prematurely and we're showing the tooltip, focus it + if(allow !== FALSE && state) { this.focus(event); } + + // If the state hasn't changed or the user stopped it, return early + if(!allow || identicalState) { return this; } + + // Set ARIA hidden attribute + $.attr(tooltip[0], 'aria-hidden', !!!state); + + // Execute state specific properties + if(state) { + // Store show origin coordinates + cache.origin = $.extend({}, this.mouse); + + // Update tooltip content & title if it's a dynamic function + if($.isFunction(contentOptions.text)) { this._updateContent(contentOptions.text, FALSE); } + if($.isFunction(contentOptions.title)) { this._updateTitle(contentOptions.title, FALSE); } + + // Cache mousemove events for positioning purposes (if not already tracking) + if(!trackingBound && posOptions.target === 'mouse' && posOptions.adjust.mouse) { + $(document).bind('mousemove.'+NAMESPACE, this._storeMouse); + trackingBound = TRUE; + } + + // Update the tooltip position (set width first to prevent viewport/max-width issues) + if(!width) { tooltip.css('width', tooltip.outerWidth(FALSE)); } + this.reposition(event, arguments[2]); + if(!width) { tooltip.css('width', ''); } + + // Hide other tooltips if tooltip is solo + if(!!opts.solo) { + (typeof opts.solo === 'string' ? $(opts.solo) : $(SELECTOR, opts.solo)) + .not(tooltip).not(opts.target).qtip('hide', $.Event('tooltipsolo')); + } + } + else { + // Clear show timer if we're hiding + clearTimeout(this.timers.show); + + // Remove cached origin on hide + delete cache.origin; + + // Remove mouse tracking event if not needed (all tracking qTips are hidden) + if(trackingBound && !$(SELECTOR+'[tracking="true"]:visible', opts.solo).not(tooltip).length) { + $(document).unbind('mousemove.'+NAMESPACE); + trackingBound = FALSE; + } + + // Blur the tooltip + this.blur(event); + } + + // Define post-animation, state specific properties + after = $.proxy(function() { + if(state) { + // Prevent antialias from disappearing in IE by removing filter + if(BROWSER.ie) { tooltip[0].style.removeAttribute('filter'); } + + // Remove overflow setting to prevent tip bugs + tooltip.css('overflow', ''); + + // Autofocus elements if enabled + if('string' === typeof opts.autofocus) { + $(this.options.show.autofocus, tooltip).focus(); + } + + // If set, hide tooltip when inactive for delay period + this.options.show.target.trigger('qtip-'+this.id+'-inactive'); + } + else { + // Reset CSS states + tooltip.css({ + display: '', + visibility: '', + opacity: '', + left: '', + top: '' + }); + } + + // tooltipvisible/tooltiphidden events + this._trigger(state ? 'visible' : 'hidden'); + }, this); + + // If no effect type is supplied, use a simple toggle + if(opts.effect === FALSE || animate === FALSE) { + tooltip[ type ](); + after(); + } + + // Use custom function if provided + else if($.isFunction(opts.effect)) { + tooltip.stop(1, 1); + opts.effect.call(tooltip, this); + tooltip.queue('fx', function(n) { + after(); n(); + }); + } + + // Use basic fade function by default + else { tooltip.fadeTo(90, state ? 1 : 0, after); } + + // If inactive hide method is set, active it + if(state) { opts.target.trigger('qtip-'+this.id+'-inactive'); } + + return this; +}; + +PROTOTYPE.show = function(event) { return this.toggle(TRUE, event); }; + +PROTOTYPE.hide = function(event) { return this.toggle(FALSE, event); }; + +;PROTOTYPE.focus = function(event) { + if(!this.rendered || this.destroyed) { return this; } + + var qtips = $(SELECTOR), + tooltip = this.tooltip, + curIndex = parseInt(tooltip[0].style.zIndex, 10), + newIndex = QTIP.zindex + qtips.length, + focusedElem; + + // Only update the z-index if it has changed and tooltip is not already focused + if(!tooltip.hasClass(CLASS_FOCUS)) { + // tooltipfocus event + if(this._trigger('focus', [newIndex], event)) { + // Only update z-index's if they've changed + if(curIndex !== newIndex) { + // Reduce our z-index's and keep them properly ordered + qtips.each(function() { + if(this.style.zIndex > curIndex) { + this.style.zIndex = this.style.zIndex - 1; + } + }); + + // Fire blur event for focused tooltip + qtips.filter('.' + CLASS_FOCUS).qtip('blur', event); + } + + // Set the new z-index + tooltip.addClass(CLASS_FOCUS)[0].style.zIndex = newIndex; + } + } + + return this; +}; + +PROTOTYPE.blur = function(event) { + if(!this.rendered || this.destroyed) { return this; } + + // Set focused status to FALSE + this.tooltip.removeClass(CLASS_FOCUS); + + // tooltipblur event + this._trigger('blur', [ this.tooltip.css('zIndex') ], event); + + return this; +}; + +;PROTOTYPE.disable = function(state) { + if(this.destroyed) { return this; } + + if('boolean' !== typeof state) { + state = !(this.tooltip.hasClass(CLASS_DISABLED) || this.disabled); + } + + if(this.rendered) { + this.tooltip.toggleClass(CLASS_DISABLED, state) + .attr('aria-disabled', state); + } + + this.disabled = !!state; + + return this; +}; + +PROTOTYPE.enable = function() { return this.disable(FALSE); }; + +;PROTOTYPE._createButton = function() +{ + var self = this, + elements = this.elements, + tooltip = elements.tooltip, + button = this.options.content.button, + isString = typeof button === 'string', + close = isString ? button : 'Close tooltip'; + + if(elements.button) { elements.button.remove(); } + + // Use custom button if one was supplied by user, else use default + if(button.jquery) { + elements.button = button; + } + else { + elements.button = $('<a />', { + 'class': 'qtip-close ' + (this.options.style.widget ? '' : NAMESPACE+'-icon'), + 'title': close, + 'aria-label': close + }) + .prepend( + $('<span />', { + 'class': 'ui-icon ui-icon-close', + 'html': '×' + }) + ); + } + + // Create button and setup attributes + elements.button.appendTo(elements.titlebar || tooltip) + .attr('role', 'button') + .click(function(event) { + if(!tooltip.hasClass(CLASS_DISABLED)) { self.hide(event); } + return FALSE; + }); +}; + +PROTOTYPE._updateButton = function(button) +{ + // Make sure tooltip is rendered and if not, return + if(!this.rendered) { return FALSE; } + + var elem = this.elements.button; + if(button) { this._createButton(); } + else { elem.remove(); } +}; + +;// Widget class creator +function createWidgetClass(cls) { + return WIDGET.concat('').join(cls ? '-'+cls+' ' : ' '); +} + +// Widget class setter method +PROTOTYPE._setWidget = function() +{ + var on = this.options.style.widget, + elements = this.elements, + tooltip = elements.tooltip, + disabled = tooltip.hasClass(CLASS_DISABLED); + + tooltip.removeClass(CLASS_DISABLED); + CLASS_DISABLED = on ? 'ui-state-disabled' : 'qtip-disabled'; + tooltip.toggleClass(CLASS_DISABLED, disabled); + + tooltip.toggleClass('ui-helper-reset '+createWidgetClass(), on).toggleClass(CLASS_DEFAULT, this.options.style.def && !on); + + if(elements.content) { + elements.content.toggleClass( createWidgetClass('content'), on); + } + if(elements.titlebar) { + elements.titlebar.toggleClass( createWidgetClass('header'), on); + } + if(elements.button) { + elements.button.toggleClass(NAMESPACE+'-icon', !on); + } +};;function showMethod(event) { + if(this.tooltip.hasClass(CLASS_DISABLED)) { return FALSE; } + + // Clear hide timers + clearTimeout(this.timers.show); + clearTimeout(this.timers.hide); + + // Start show timer + var callback = $.proxy(function(){ this.toggle(TRUE, event); }, this); + if(this.options.show.delay > 0) { + this.timers.show = setTimeout(callback, this.options.show.delay); + } + else{ callback(); } +} + +function hideMethod(event) { + if(this.tooltip.hasClass(CLASS_DISABLED)) { return FALSE; } + + // Check if new target was actually the tooltip element + var relatedTarget = $(event.relatedTarget), + ontoTooltip = relatedTarget.closest(SELECTOR)[0] === this.tooltip[0], + ontoTarget = relatedTarget[0] === this.options.show.target[0]; + + // Clear timers and stop animation queue + clearTimeout(this.timers.show); + clearTimeout(this.timers.hide); + + // Prevent hiding if tooltip is fixed and event target is the tooltip. + // Or if mouse positioning is enabled and cursor momentarily overlaps + if(this !== relatedTarget[0] && + (this.options.position.target === 'mouse' && ontoTooltip) || + (this.options.hide.fixed && ( + (/mouse(out|leave|move)/).test(event.type) && (ontoTooltip || ontoTarget)) + )) + { + try { + event.preventDefault(); + event.stopImmediatePropagation(); + } catch(e) {} + + return; + } + + // If tooltip has displayed, start hide timer + var callback = $.proxy(function(){ this.toggle(FALSE, event); }, this); + if(this.options.hide.delay > 0) { + this.timers.hide = setTimeout(callback, this.options.hide.delay); + } + else{ callback(); } +} + +function inactiveMethod(event) { + if(this.tooltip.hasClass(CLASS_DISABLED) || !this.options.hide.inactive) { return FALSE; } + + // Clear timer + clearTimeout(this.timers.inactive); + this.timers.inactive = setTimeout( + $.proxy(function(){ this.hide(event); }, this), this.options.hide.inactive + ); +} + +function repositionMethod(event) { + if(this.rendered && this.tooltip[0].offsetWidth > 0) { this.reposition(event); } +} + +// Store mouse coordinates +PROTOTYPE._storeMouse = function(event) { + this.mouse = { + pageX: event.pageX, + pageY: event.pageY, + type: 'mousemove', + scrollX: window.pageXOffset || document.body.scrollLeft || document.documentElement.scrollLeft, + scrollY: window.pageYOffset || document.body.scrollTop || document.documentElement.scrollTop + }; +}; + +// Bind events +PROTOTYPE._bind = function(targets, events, method, suffix, context) { + var ns = '.' + this._id + (suffix ? '-'+suffix : ''); + events.length && $(targets).bind( + (events.split ? events : events.join(ns + ' ')) + ns, + $.proxy(method, context || this) + ); +}; +PROTOTYPE._unbind = function(targets, suffix) { + $(targets).unbind('.' + this._id + (suffix ? '-'+suffix : '')); +}; + +// Apply common event handlers using delegate (avoids excessive .bind calls!) +var ns = '.'+NAMESPACE; +function delegate(selector, events, method) { + $(document.body).delegate(selector, + (events.split ? events : events.join(ns + ' ')) + ns, + function() { + var api = QTIP.api[ $.attr(this, ATTR_ID) ]; + api && !api.disabled && method.apply(api, arguments); + } + ); +} + +$(function() { + delegate(SELECTOR, ['mouseenter', 'mouseleave'], function(event) { + var state = event.type === 'mouseenter', + tooltip = $(event.currentTarget), + target = $(event.relatedTarget || event.target), + options = this.options; + + // On mouseenter... + if(state) { + // Focus the tooltip on mouseenter (z-index stacking) + this.focus(event); + + // Clear hide timer on tooltip hover to prevent it from closing + tooltip.hasClass(CLASS_FIXED) && !tooltip.hasClass(CLASS_DISABLED) && clearTimeout(this.timers.hide); + } + + // On mouseleave... + else { + // Hide when we leave the tooltip and not onto the show target (if a hide event is set) + if(options.position.target === 'mouse' && options.hide.event && + options.show.target && !target.closest(options.show.target[0]).length) { + this.hide(event); + } + } + + // Add hover class + tooltip.toggleClass(CLASS_HOVER, state); + }); + + // Define events which reset the 'inactive' event handler + delegate('['+ATTR_ID+']', INACTIVE_EVENTS, inactiveMethod); +}); + +// Event trigger +PROTOTYPE._trigger = function(type, args, event) { + var callback = $.Event('tooltip'+type); + callback.originalEvent = (event && $.extend({}, event)) || this.cache.event || NULL; + + this.triggering = TRUE; + this.tooltip.trigger(callback, [this].concat(args || [])); + this.triggering = FALSE; + + return !callback.isDefaultPrevented(); +}; + +// Event assignment method +PROTOTYPE._assignEvents = function() { + var options = this.options, + posOptions = options.position, + + tooltip = this.tooltip, + showTarget = options.show.target, + hideTarget = options.hide.target, + containerTarget = posOptions.container, + viewportTarget = posOptions.viewport, + documentTarget = $(document), + bodyTarget = $(document.body), + windowTarget = $(window), + + showEvents = options.show.event ? $.trim('' + options.show.event).split(' ') : [], + hideEvents = options.hide.event ? $.trim('' + options.hide.event).split(' ') : [], + toggleEvents = []; + + // Hide tooltips when leaving current window/frame (but not select/option elements) + if(/mouse(out|leave)/i.test(options.hide.event) && options.hide.leave === 'window') { + this._bind(documentTarget, ['mouseout', 'blur'], function(event) { + if(!/select|option/.test(event.target.nodeName) && !event.relatedTarget) { + this.hide(event); + } + }); + } + + // Enable hide.fixed by adding appropriate class + if(options.hide.fixed) { + hideTarget = hideTarget.add( tooltip.addClass(CLASS_FIXED) ); + } + + /* + * Make sure hoverIntent functions properly by using mouseleave to clear show timer if + * mouseenter/mouseout is used for show.event, even if it isn't in the users options. + */ + else if(/mouse(over|enter)/i.test(options.show.event)) { + this._bind(hideTarget, 'mouseleave', function() { + clearTimeout(this.timers.show); + }); + } + + // Hide tooltip on document mousedown if unfocus events are enabled + if(('' + options.hide.event).indexOf('unfocus') > -1) { + this._bind(containerTarget.closest('html'), ['mousedown', 'touchstart'], function(event) { + var elem = $(event.target), + enabled = this.rendered && !this.tooltip.hasClass(CLASS_DISABLED) && this.tooltip[0].offsetWidth > 0, + isAncestor = elem.parents(SELECTOR).filter(this.tooltip[0]).length > 0; + + if(elem[0] !== this.target[0] && elem[0] !== this.tooltip[0] && !isAncestor && + !this.target.has(elem[0]).length && enabled + ) { + this.hide(event); + } + }); + } + + // Check if the tooltip hides when inactive + if('number' === typeof options.hide.inactive) { + // Bind inactive method to show target(s) as a custom event + this._bind(showTarget, 'qtip-'+this.id+'-inactive', inactiveMethod); + + // Define events which reset the 'inactive' event handler + this._bind(hideTarget.add(tooltip), QTIP.inactiveEvents, inactiveMethod, '-inactive'); + } + + // Apply hide events (and filter identical show events) + hideEvents = $.map(hideEvents, function(type) { + var showIndex = $.inArray(type, showEvents); + + // Both events and targets are identical, apply events using a toggle + if((showIndex > -1 && hideTarget.add(showTarget).length === hideTarget.length)) { + toggleEvents.push( showEvents.splice( showIndex, 1 )[0] ); return; + } + + return type; + }); + + // Apply show/hide/toggle events + this._bind(showTarget, showEvents, showMethod); + this._bind(hideTarget, hideEvents, hideMethod); + this._bind(showTarget, toggleEvents, function(event) { + (this.tooltip[0].offsetWidth > 0 ? hideMethod : showMethod).call(this, event); + }); + + + // Mouse movement bindings + this._bind(showTarget.add(tooltip), 'mousemove', function(event) { + // Check if the tooltip hides when mouse is moved a certain distance + if('number' === typeof options.hide.distance) { + var origin = this.cache.origin || {}, + limit = this.options.hide.distance, + abs = Math.abs; + + // Check if the movement has gone beyond the limit, and hide it if so + if(abs(event.pageX - origin.pageX) >= limit || abs(event.pageY - origin.pageY) >= limit) { + this.hide(event); + } + } + + // Cache mousemove coords on show targets + this._storeMouse(event); + }); + + // Mouse positioning events + if(posOptions.target === 'mouse') { + // If mouse adjustment is on... + if(posOptions.adjust.mouse) { + // Apply a mouseleave event so we don't get problems with overlapping + if(options.hide.event) { + // Track if we're on the target or not + this._bind(showTarget, ['mouseenter', 'mouseleave'], function(event) { + this.cache.onTarget = event.type === 'mouseenter'; + }); + } + + // Update tooltip position on mousemove + this._bind(documentTarget, 'mousemove', function(event) { + // Update the tooltip position only if the tooltip is visible and adjustment is enabled + if(this.rendered && this.cache.onTarget && !this.tooltip.hasClass(CLASS_DISABLED) && this.tooltip[0].offsetWidth > 0) { + this.reposition(event); + } + }); + } + } + + // Adjust positions of the tooltip on window resize if enabled + if(posOptions.adjust.resize || viewportTarget.length) { + this._bind( $.event.special.resize ? viewportTarget : windowTarget, 'resize', repositionMethod ); + } + + // Adjust tooltip position on scroll of the window or viewport element if present + if(posOptions.adjust.scroll) { + this._bind( windowTarget.add(posOptions.container), 'scroll', repositionMethod ); + } +}; + +// Un-assignment method +PROTOTYPE._unassignEvents = function() { + var targets = [ + this.options.show.target[0], + this.options.hide.target[0], + this.rendered && this.tooltip[0], + this.options.position.container[0], + this.options.position.viewport[0], + this.options.position.container.closest('html')[0], // unfocus + window, + document + ]; + + // Check if tooltip is rendered + if(this.rendered) { + this._unbind($([]).pushStack( $.grep(targets, function(i) { + return typeof i === 'object'; + }))); + } + + // Tooltip isn't yet rendered, remove render event + else { $(targets[0]).unbind('.'+this._id+'-create'); } +}; + +;// Initialization method +function init(elem, id, opts) +{ + var obj, posOptions, attr, config, title, + + // Setup element references + docBody = $(document.body), + + // Use document body instead of document element if needed + newTarget = elem[0] === document ? docBody : elem, + + // Grab metadata from element if plugin is present + metadata = (elem.metadata) ? elem.metadata(opts.metadata) : NULL, + + // If metadata type if HTML5, grab 'name' from the object instead, or use the regular data object otherwise + metadata5 = opts.metadata.type === 'html5' && metadata ? metadata[opts.metadata.name] : NULL, + + // Grab data from metadata.name (or data-qtipopts as fallback) using .data() method, + html5 = elem.data(opts.metadata.name || 'qtipopts'); + + // If we don't get an object returned attempt to parse it manualyl without parseJSON + try { html5 = typeof html5 === 'string' ? $.parseJSON(html5) : html5; } catch(e) {} + + // Merge in and sanitize metadata + config = $.extend(TRUE, {}, QTIP.defaults, opts, + typeof html5 === 'object' ? sanitizeOptions(html5) : NULL, + sanitizeOptions(metadata5 || metadata)); + + // Re-grab our positioning options now we've merged our metadata and set id to passed value + posOptions = config.position; + config.id = id; + + // Setup missing content if none is detected + if('boolean' === typeof config.content.text) { + attr = elem.attr(config.content.attr); + + // Grab from supplied attribute if available + if(config.content.attr !== FALSE && attr) { config.content.text = attr; } + + // No valid content was found, abort render + else { return FALSE; } + } + + // Setup target options + if(!posOptions.container.length) { posOptions.container = docBody; } + if(posOptions.target === FALSE) { posOptions.target = newTarget; } + if(config.show.target === FALSE) { config.show.target = newTarget; } + if(config.show.solo === TRUE) { config.show.solo = posOptions.container.closest('body'); } + if(config.hide.target === FALSE) { config.hide.target = newTarget; } + if(config.position.viewport === TRUE) { config.position.viewport = posOptions.container; } + + // Ensure we only use a single container + posOptions.container = posOptions.container.eq(0); + + // Convert position corner values into x and y strings + posOptions.at = new CORNER(posOptions.at, TRUE); + posOptions.my = new CORNER(posOptions.my); + + // Destroy previous tooltip if overwrite is enabled, or skip element if not + if(elem.data(NAMESPACE)) { + if(config.overwrite) { + elem.qtip('destroy'); + } + else if(config.overwrite === FALSE) { + return FALSE; + } + } + + // Add has-qtip attribute + elem.attr(ATTR_HAS, id); + + // Remove title attribute and store it if present + if(config.suppress && (title = elem.attr('title'))) { + // Final attr call fixes event delegatiom and IE default tooltip showing problem + elem.removeAttr('title').attr(oldtitle, title).attr('title', ''); + } + + // Initialize the tooltip and add API reference + obj = new QTip(elem, config, id, !!attr); + elem.data(NAMESPACE, obj); + + // Catch remove/removeqtip events on target element to destroy redundant tooltip + elem.one('remove.qtip-'+id+' removeqtip.qtip-'+id, function() { + var api; if((api = $(this).data(NAMESPACE))) { api.destroy(); } + }); + + return obj; +} + +// jQuery $.fn extension method +QTIP = $.fn.qtip = function(options, notation, newValue) +{ + var command = ('' + options).toLowerCase(), // Parse command + returned = NULL, + args = $.makeArray(arguments).slice(1), + event = args[args.length - 1], + opts = this[0] ? $.data(this[0], NAMESPACE) : NULL; + + // Check for API request + if((!arguments.length && opts) || command === 'api') { + return opts; + } + + // Execute API command if present + else if('string' === typeof options) + { + this.each(function() + { + var api = $.data(this, NAMESPACE); + if(!api) { return TRUE; } + + // Cache the event if possible + if(event && event.timeStamp) { api.cache.event = event; } + + // Check for specific API commands + if(notation && (command === 'option' || command === 'options')) { + if(newValue !== undefined || $.isPlainObject(notation)) { + api.set(notation, newValue); + } + else { + returned = api.get(notation); + return FALSE; + } + } + + // Execute API command + else if(api[command]) { + api[command].apply(api, args); + } + }); + + return returned !== NULL ? returned : this; + } + + // No API commands. validate provided options and setup qTips + else if('object' === typeof options || !arguments.length) + { + opts = sanitizeOptions($.extend(TRUE, {}, options)); + + // Bind the qTips + return QTIP.bind.call(this, opts, event); + } +}; + +// $.fn.qtip Bind method +QTIP.bind = function(opts, event) +{ + return this.each(function(i) { + var options, targets, events, namespace, api, id; + + // Find next available ID, or use custom ID if provided + id = $.isArray(opts.id) ? opts.id[i] : opts.id; + id = !id || id === FALSE || id.length < 1 || QTIP.api[id] ? QTIP.nextid++ : id; + + // Setup events namespace + namespace = '.qtip-'+id+'-create'; + + // Initialize the qTip and re-grab newly sanitized options + api = init($(this), id, opts); + if(api === FALSE) { return TRUE; } + else { QTIP.api[id] = api; } + options = api.options; + + // Initialize plugins + $.each(PLUGINS, function() { + if(this.initialize === 'initialize') { this(api); } + }); + + // Determine hide and show targets + targets = { show: options.show.target, hide: options.hide.target }; + events = { + show: $.trim('' + options.show.event).replace(/ /g, namespace+' ') + namespace, + hide: $.trim('' + options.hide.event).replace(/ /g, namespace+' ') + namespace + }; + + /* + * Make sure hoverIntent functions properly by using mouseleave as a hide event if + * mouseenter/mouseout is used for show.event, even if it isn't in the users options. + */ + if(/mouse(over|enter)/i.test(events.show) && !/mouse(out|leave)/i.test(events.hide)) { + events.hide += ' mouseleave' + namespace; + } + + /* + * Also make sure initial mouse targetting works correctly by caching mousemove coords + * on show targets before the tooltip has rendered. + * + * Also set onTarget when triggered to keep mouse tracking working + */ + targets.show.bind('mousemove'+namespace, function(event) { + api._storeMouse(event); + api.cache.onTarget = TRUE; + }); + + // Define hoverIntent function + function hoverIntent(event) { + function render() { + // Cache mouse coords,render and render the tooltip + api.render(typeof event === 'object' || options.show.ready); + + // Unbind show and hide events + targets.show.add(targets.hide).unbind(namespace); + } + + // Only continue if tooltip isn't disabled + if(api.disabled) { return FALSE; } + + // Cache the event data + api.cache.event = $.extend({}, event); + api.cache.target = event ? $(event.target) : [undefined]; + + // Start the event sequence + if(options.show.delay > 0) { + clearTimeout(api.timers.show); + api.timers.show = setTimeout(render, options.show.delay); + if(events.show !== events.hide) { + targets.hide.bind(events.hide, function() { clearTimeout(api.timers.show); }); + } + } + else { render(); } + } + + // Bind show events to target + targets.show.bind(events.show, hoverIntent); + + // Prerendering is enabled, create tooltip now + if(options.show.ready || options.prerender) { hoverIntent(event); } + }); +}; + +// Populated in render method +QTIP.api = {}; +;$.each({ + /* Allow other plugins to successfully retrieve the title of an element with a qTip applied */ + attr: function(attr, val) { + if(this.length) { + var self = this[0], + title = 'title', + api = $.data(self, 'qtip'); + + if(attr === title && api && 'object' === typeof api && api.options.suppress) { + if(arguments.length < 2) { + return $.attr(self, oldtitle); + } + + // If qTip is rendered and title was originally used as content, update it + if(api && api.options.content.attr === title && api.cache.attr) { + api.set('content.text', val); + } + + // Use the regular attr method to set, then cache the result + return this.attr(oldtitle, val); + } + } + + return $.fn['attr'+replaceSuffix].apply(this, arguments); + }, + + /* Allow clone to correctly retrieve cached title attributes */ + clone: function(keepData) { + var titles = $([]), title = 'title', + + // Clone our element using the real clone method + elems = $.fn['clone'+replaceSuffix].apply(this, arguments); + + // Grab all elements with an oldtitle set, and change it to regular title attribute, if keepData is false + if(!keepData) { + elems.filter('['+oldtitle+']').attr('title', function() { + return $.attr(this, oldtitle); + }) + .removeAttr(oldtitle); + } + + return elems; + } +}, function(name, func) { + if(!func || $.fn[name+replaceSuffix]) { return TRUE; } + + var old = $.fn[name+replaceSuffix] = $.fn[name]; + $.fn[name] = function() { + return func.apply(this, arguments) || old.apply(this, arguments); + }; +}); + +/* Fire off 'removeqtip' handler in $.cleanData if jQuery UI not present (it already does similar). + * This snippet is taken directly from jQuery UI source code found here: + * http://code.jquery.com/ui/jquery-ui-git.js + */ +if(!$.ui) { + $['cleanData'+replaceSuffix] = $.cleanData; + $.cleanData = function( elems ) { + for(var i = 0, elem; (elem = $( elems[i] )).length; i++) { + if(elem.attr(ATTR_HAS)) { + try { elem.triggerHandler('removeqtip'); } + catch( e ) {} + } + } + $['cleanData'+replaceSuffix].apply(this, arguments); + }; +} + +;// qTip version +QTIP.version = '2.1.1'; + +// Base ID for all qTips +QTIP.nextid = 0; + +// Inactive events array +QTIP.inactiveEvents = INACTIVE_EVENTS; + +// Base z-index for all qTips +QTIP.zindex = 15000; + +// Define configuration defaults +QTIP.defaults = { + prerender: FALSE, + id: FALSE, + overwrite: TRUE, + suppress: TRUE, + content: { + text: TRUE, + attr: 'title', + title: FALSE, + button: FALSE + }, + position: { + my: 'top left', + at: 'bottom right', + target: FALSE, + container: FALSE, + viewport: FALSE, + adjust: { + x: 0, y: 0, + mouse: TRUE, + scroll: TRUE, + resize: TRUE, + method: 'flipinvert flipinvert' + }, + effect: function(api, pos, viewport) { + $(this).animate(pos, { + duration: 200, + queue: FALSE + }); + } + }, + show: { + target: FALSE, + event: 'mouseenter', + effect: TRUE, + delay: 90, + solo: FALSE, + ready: FALSE, + autofocus: FALSE + }, + hide: { + target: FALSE, + event: 'mouseleave', + effect: TRUE, + delay: 0, + fixed: FALSE, + inactive: FALSE, + leave: 'window', + distance: FALSE + }, + style: { + classes: '', + widget: FALSE, + width: FALSE, + height: FALSE, + def: TRUE + }, + events: { + render: NULL, + move: NULL, + show: NULL, + hide: NULL, + toggle: NULL, + visible: NULL, + hidden: NULL, + focus: NULL, + blur: NULL + } +}; + +;var TIP, + +// .bind()/.on() namespace +TIPNS = '.qtip-tip', + +// Common CSS strings +MARGIN = 'margin', +BORDER = 'border', +COLOR = 'color', +BG_COLOR = 'background-color', +TRANSPARENT = 'transparent', +IMPORTANT = ' !important', + +// Check if the browser supports <canvas/> elements +HASCANVAS = !!document.createElement('canvas').getContext, + +// Invalid colour values used in parseColours() +INVALID = /rgba?\(0, 0, 0(, 0)?\)|transparent|#123456/i; + +// Camel-case method, taken from jQuery source +// http://code.jquery.com/jquery-1.8.0.js +function camel(s) { return s.charAt(0).toUpperCase() + s.slice(1); } + +/* + * Modified from Modernizr's testPropsAll() + * http://modernizr.com/downloads/modernizr-latest.js + */ +var cssProps = {}, cssPrefixes = ["Webkit", "O", "Moz", "ms"]; +function vendorCss(elem, prop) { + var ucProp = prop.charAt(0).toUpperCase() + prop.slice(1), + props = (prop + ' ' + cssPrefixes.join(ucProp + ' ') + ucProp).split(' '), + cur, val, i = 0; + + // If the property has already been mapped... + if(cssProps[prop]) { return elem.css(cssProps[prop]); } + + while((cur = props[i++])) { + if((val = elem.css(cur)) !== undefined) { + return cssProps[prop] = cur, val; + } + } +} + +// Parse a given elements CSS property into an int +function intCss(elem, prop) { + return parseInt(vendorCss(elem, prop), 10); +} + + +// VML creation (for IE only) +if(!HASCANVAS) { + createVML = function(tag, props, style) { + return '<qtipvml:'+tag+' xmlns="urn:schemas-microsoft.com:vml" class="qtip-vml" '+(props||'')+ + ' style="behavior: url(#default#VML); '+(style||'')+ '" />'; + }; +} + + + +function Tip(qtip, options) { + this._ns = 'tip'; + this.options = options; + this.offset = options.offset; + this.size = [ options.width, options.height ]; + + // Initialize + this.init( (this.qtip = qtip) ); +} + +$.extend(Tip.prototype, { + init: function(qtip) { + var context, tip; + + // Create tip element and prepend to the tooltip + tip = this.element = qtip.elements.tip = $('<div />', { 'class': NAMESPACE+'-tip' }).prependTo(qtip.tooltip); + + // Create tip drawing element(s) + if(HASCANVAS) { + // save() as soon as we create the canvas element so FF2 doesn't bork on our first restore()! + context = $('<canvas />').appendTo(this.element)[0].getContext('2d'); + + // Setup constant parameters + context.lineJoin = 'miter'; + context.miterLimit = 100; + context.save(); + } + else { + context = createVML('shape', 'coordorigin="0,0"', 'position:absolute;'); + this.element.html(context + context); + + // Prevent mousing down on the tip since it causes problems with .live() handling in IE due to VML + qtip._bind( $('*', tip).add(tip), ['click', 'mousedown'], function(event) { event.stopPropagation(); }, this._ns); + } + + // Bind update events + qtip._bind(qtip.tooltip, 'tooltipmove', this.reposition, this._ns, this); + + // Create it + this.create(); + }, + + _swapDimensions: function() { + this.size[0] = this.options.height; + this.size[1] = this.options.width; + }, + _resetDimensions: function() { + this.size[0] = this.options.width; + this.size[1] = this.options.height; + }, + + _useTitle: function(corner) { + var titlebar = this.qtip.elements.titlebar; + return titlebar && ( + corner.y === TOP || (corner.y === CENTER && this.element.position().top + (this.size[1] / 2) + this.options.offset < titlebar.outerHeight(TRUE)) + ); + }, + + _parseCorner: function(corner) { + var my = this.qtip.options.position.my; + + // Detect corner and mimic properties + if(corner === FALSE || my === FALSE) { + corner = FALSE; + } + else if(corner === TRUE) { + corner = new CORNER( my.string() ); + } + else if(!corner.string) { + corner = new CORNER(corner); + corner.fixed = TRUE; + } + + return corner; + }, + + _parseWidth: function(corner, side, use) { + var elements = this.qtip.elements, + prop = BORDER + camel(side) + 'Width'; + + return (use ? intCss(use, prop) : ( + intCss(elements.content, prop) || + intCss(this._useTitle(corner) && elements.titlebar || elements.content, prop) || + intCss(tooltip, prop) + )) || 0; + }, + + _parseRadius: function(corner) { + var elements = this.qtip.elements, + prop = BORDER + camel(corner.y) + camel(corner.x) + 'Radius'; + + return BROWSER.ie < 9 ? 0 : + intCss(this._useTitle(corner) && elements.titlebar || elements.content, prop) || + intCss(elements.tooltip, prop) || 0; + }, + + _invalidColour: function(elem, prop, compare) { + var val = elem.css(prop); + return !val || (compare && val === elem.css(compare)) || INVALID.test(val) ? FALSE : val; + }, + + _parseColours: function(corner) { + var elements = this.qtip.elements, + tip = this.element.css('cssText', ''), + borderSide = BORDER + camel(corner[ corner.precedance ]) + camel(COLOR), + colorElem = this._useTitle(corner) && elements.titlebar || elements.content, + css = this._invalidColour, color = []; + + // Attempt to detect the background colour from various elements, left-to-right precedance + color[0] = css(tip, BG_COLOR) || css(colorElem, BG_COLOR) || css(elements.content, BG_COLOR) || + css(tooltip, BG_COLOR) || tip.css(BG_COLOR); + + // Attempt to detect the correct border side colour from various elements, left-to-right precedance + color[1] = css(tip, borderSide, COLOR) || css(colorElem, borderSide, COLOR) || + css(elements.content, borderSide, COLOR) || css(tooltip, borderSide, COLOR) || tooltip.css(borderSide); + + // Reset background and border colours + $('*', tip).add(tip).css('cssText', BG_COLOR+':'+TRANSPARENT+IMPORTANT+';'+BORDER+':0'+IMPORTANT+';'); + + return color; + }, + + _calculateSize: function(corner) { + var y = corner.precedance === Y, + width = this.options[ y ? 'height' : 'width' ], + height = this.options[ y ? 'width' : 'height' ], + isCenter = corner.abbrev() === 'c', + base = width * (isCenter ? 0.5 : 1), + pow = Math.pow, + round = Math.round, + bigHyp, ratio, result, + + smallHyp = Math.sqrt( pow(base, 2) + pow(height, 2) ), + hyp = [ (this.border / base) * smallHyp, (this.border / height) * smallHyp ]; + + hyp[2] = Math.sqrt( pow(hyp[0], 2) - pow(this.border, 2) ); + hyp[3] = Math.sqrt( pow(hyp[1], 2) - pow(this.border, 2) ); + + bigHyp = smallHyp + hyp[2] + hyp[3] + (isCenter ? 0 : hyp[0]); + ratio = bigHyp / smallHyp; + + result = [ round(ratio * width), round(ratio * height) ]; + + return y ? result : result.reverse(); + }, + + // Tip coordinates calculator + _calculateTip: function(corner) { + var width = this.size[0], height = this.size[1], + width2 = Math.ceil(width / 2), height2 = Math.ceil(height / 2), + + // Define tip coordinates in terms of height and width values + tips = { + br: [0,0, width,height, width,0], + bl: [0,0, width,0, 0,height], + tr: [0,height, width,0, width,height], + tl: [0,0, 0,height, width,height], + tc: [0,height, width2,0, width,height], + bc: [0,0, width,0, width2,height], + rc: [0,0, width,height2, 0,height], + lc: [width,0, width,height, 0,height2] + }; + + // Set common side shapes + tips.lt = tips.br; tips.rt = tips.bl; + tips.lb = tips.tr; tips.rb = tips.tl; + + return tips[ corner.abbrev() ]; + }, + + create: function() { + // Determine tip corner + var c = this.corner = (HASCANVAS || BROWSER.ie) && this._parseCorner(this.options.corner); + + // If we have a tip corner... + if( (this.enabled = !!this.corner && this.corner.abbrev() !== 'c') ) { + // Cache it + this.qtip.cache.corner = c.clone(); + + // Create it + this.update(); + } + + // Toggle tip element + this.element.toggle(this.enabled); + + return this.corner; + }, + + update: function(corner, position) { + if(!this.enabled) { return this; } + + var elements = this.qtip.elements, + tip = this.element, + inner = tip.children(), + options = this.options, + size = this.size, + mimic = options.mimic, + round = Math.round, + color, precedance, context, + coords, translate, newSize, border; + + // Re-determine tip if not already set + if(!corner) { corner = this.qtip.cache.corner || this.corner; } + + // Use corner property if we detect an invalid mimic value + if(mimic === FALSE) { mimic = corner; } + + // Otherwise inherit mimic properties from the corner object as necessary + else { + mimic = new CORNER(mimic); + mimic.precedance = corner.precedance; + + if(mimic.x === 'inherit') { mimic.x = corner.x; } + else if(mimic.y === 'inherit') { mimic.y = corner.y; } + else if(mimic.x === mimic.y) { + mimic[ corner.precedance ] = corner[ corner.precedance ]; + } + } + precedance = mimic.precedance; + + // Ensure the tip width.height are relative to the tip position + if(corner.precedance === X) { this._swapDimensions(); } + else { this._resetDimensions(); } + + // Update our colours + color = this.color = this._parseColours(corner); + + // Detect border width, taking into account colours + if(color[1] !== TRANSPARENT) { + // Grab border width + border = this.border = this._parseWidth(corner, corner[corner.precedance]); + + // If border width isn't zero, use border color as fill (1.0 style tips) + if(options.border && border < 1) { color[0] = color[1]; } + + // Set border width (use detected border width if options.border is true) + this.border = border = options.border !== TRUE ? options.border : border; + } + + // Border colour was invalid, set border to zero + else { this.border = border = 0; } + + // Calculate coordinates + coords = this._calculateTip(mimic); + + // Determine tip size + newSize = this.size = this._calculateSize(corner); + tip.css({ + width: newSize[0], + height: newSize[1], + lineHeight: newSize[1]+'px' + }); + + // Calculate tip translation + if(corner.precedance === Y) { + translate = [ + round(mimic.x === LEFT ? border : mimic.x === RIGHT ? newSize[0] - size[0] - border : (newSize[0] - size[0]) / 2), + round(mimic.y === TOP ? newSize[1] - size[1] : 0) + ]; + } + else { + translate = [ + round(mimic.x === LEFT ? newSize[0] - size[0] : 0), + round(mimic.y === TOP ? border : mimic.y === BOTTOM ? newSize[1] - size[1] - border : (newSize[1] - size[1]) / 2) + ]; + } + + // Canvas drawing implementation + if(HASCANVAS) { + // Set the canvas size using calculated size + inner.attr(WIDTH, newSize[0]).attr(HEIGHT, newSize[1]); + + // Grab canvas context and clear/save it + context = inner[0].getContext('2d'); + context.restore(); context.save(); + context.clearRect(0,0,3000,3000); + + // Set properties + context.fillStyle = color[0]; + context.strokeStyle = color[1]; + context.lineWidth = border * 2; + + // Draw the tip + context.translate(translate[0], translate[1]); + context.beginPath(); + context.moveTo(coords[0], coords[1]); + context.lineTo(coords[2], coords[3]); + context.lineTo(coords[4], coords[5]); + context.closePath(); + + // Apply fill and border + if(border) { + // Make sure transparent borders are supported by doing a stroke + // of the background colour before the stroke colour + if(tooltip.css('background-clip') === 'border-box') { + context.strokeStyle = color[0]; + context.stroke(); + } + context.strokeStyle = color[1]; + context.stroke(); + } + context.fill(); + } + + // VML (IE Proprietary implementation) + else { + // Setup coordinates string + coords = 'm' + coords[0] + ',' + coords[1] + ' l' + coords[2] + + ',' + coords[3] + ' ' + coords[4] + ',' + coords[5] + ' xe'; + + // Setup VML-specific offset for pixel-perfection + translate[2] = border && /^(r|b)/i.test(corner.string()) ? + BROWSER.ie === 8 ? 2 : 1 : 0; + + // Set initial CSS + inner.css({ + coordsize: (size[0]+border) + ' ' + (size[1]+border), + antialias: ''+(mimic.string().indexOf(CENTER) > -1), + left: translate[0] - (translate[2] * Number(precedance === X)), + top: translate[1] - (translate[2] * Number(precedance === Y)), + width: size[0] + border, + height: size[1] + border + }) + .each(function(i) { + var $this = $(this); + + // Set shape specific attributes + $this[ $this.prop ? 'prop' : 'attr' ]({ + coordsize: (size[0]+border) + ' ' + (size[1]+border), + path: coords, + fillcolor: color[0], + filled: !!i, + stroked: !i + }) + .toggle(!!(border || i)); + + // Check if border is enabled and add stroke element + !i && $this.html( createVML( + 'stroke', 'weight="'+(border*2)+'px" color="'+color[1]+'" miterlimit="1000" joinstyle="miter"' + ) ); + }); + } + + // Position if needed + if(position !== FALSE) { this.calculate(corner); } + }, + + calculate: function(corner) { + if(!this.enabled) { return FALSE; } + + var self = this, + elements = this.qtip.elements, + tip = this.element, + userOffset = this.options.offset, + isWidget = this.qtip.tooltip.hasClass('ui-widget'), + position = { }, + precedance, size, corners; + + // Inherit corner if not provided + corner = corner || this.corner; + precedance = corner.precedance; + + // Determine which tip dimension to use for adjustment + size = this._calculateSize(corner); + + // Setup corners and offset array + corners = [ corner.x, corner.y ]; + if(precedance === X) { corners.reverse(); } + + // Calculate tip position + $.each(corners, function(i, side) { + var b, bc, br; + + if(side === CENTER) { + b = precedance === Y ? LEFT : TOP; + position[ b ] = '50%'; + position[MARGIN+'-' + b] = -Math.round(size[ precedance === Y ? 0 : 1 ] / 2) + userOffset; + } + else { + b = self._parseWidth(corner, side, elements.tooltip); + bc = self._parseWidth(corner, side, elements.content); + br = self._parseRadius(corner); + + position[ side ] = Math.max(-self.border, i ? bc : (userOffset + (br > b ? br : -b))); + } + }); + + // Adjust for tip size + position[ corner[precedance] ] -= size[ precedance === X ? 0 : 1 ]; + + // Set and return new position + tip.css({ margin: '', top: '', bottom: '', left: '', right: '' }).css(position); + return position; + }, + + reposition: function(event, api, pos, viewport) { + if(!this.enabled) { return; } + + var cache = api.cache, + newCorner = this.corner.clone(), + adjust = pos.adjusted, + method = api.options.position.adjust.method.split(' '), + horizontal = method[0], + vertical = method[1] || method[0], + shift = { left: FALSE, top: FALSE, x: 0, y: 0 }, + offset, css = {}, props; + + // If our tip position isn't fixed e.g. doesn't adjust with viewport... + if(this.corner.fixed !== TRUE) { + // Horizontal - Shift or flip method + if(horizontal === SHIFT && newCorner.precedance === X && adjust.left && newCorner.y !== CENTER) { + newCorner.precedance = newCorner.precedance === X ? Y : X; + } + else if(horizontal !== SHIFT && adjust.left){ + newCorner.x = newCorner.x === CENTER ? (adjust.left > 0 ? LEFT : RIGHT) : (newCorner.x === LEFT ? RIGHT : LEFT); + } + + // Vertical - Shift or flip method + if(vertical === SHIFT && newCorner.precedance === Y && adjust.top && newCorner.x !== CENTER) { + newCorner.precedance = newCorner.precedance === Y ? X : Y; + } + else if(vertical !== SHIFT && adjust.top) { + newCorner.y = newCorner.y === CENTER ? (adjust.top > 0 ? TOP : BOTTOM) : (newCorner.y === TOP ? BOTTOM : TOP); + } + + // Update and redraw the tip if needed (check cached details of last drawn tip) + if(newCorner.string() !== cache.corner.string() && (cache.cornerTop !== adjust.top || cache.cornerLeft !== adjust.left)) { + this.update(newCorner, FALSE); + } + } + + // Setup tip offset properties + offset = this.calculate(newCorner, adjust); + + // Readjust offset object to make it left/top + if(offset.right !== undefined) { offset.left = -offset.right; } + if(offset.bottom !== undefined) { offset.top = -offset.bottom; } + offset.user = this.offset; + + // Viewport "shift" specific adjustments + if(shift.left = (horizontal === SHIFT && !!adjust.left)) { + if(newCorner.x === CENTER) { + css[MARGIN+'-left'] = shift.x = offset[MARGIN+'-left'] - adjust.left; + } + else { + props = offset.right !== undefined ? + [ adjust.left, -offset.left ] : [ -adjust.left, offset.left ]; + + if( (shift.x = Math.max(props[0], props[1])) > props[0] ) { + pos.left -= adjust.left; + shift.left = FALSE; + } + + css[ offset.right !== undefined ? RIGHT : LEFT ] = shift.x; + } + } + if(shift.top = (vertical === SHIFT && !!adjust.top)) { + if(newCorner.y === CENTER) { + css[MARGIN+'-top'] = shift.y = offset[MARGIN+'-top'] - adjust.top; + } + else { + props = offset.bottom !== undefined ? + [ adjust.top, -offset.top ] : [ -adjust.top, offset.top ]; + + if( (shift.y = Math.max(props[0], props[1])) > props[0] ) { + pos.top -= adjust.top; + shift.top = FALSE; + } + + css[ offset.bottom !== undefined ? BOTTOM : TOP ] = shift.y; + } + } + + /* + * If the tip is adjusted in both dimensions, or in a + * direction that would cause it to be anywhere but the + * outer border, hide it! + */ + this.element.css(css).toggle( + !((shift.x && shift.y) || (newCorner.x === CENTER && shift.y) || (newCorner.y === CENTER && shift.x)) + ); + + // Adjust position to accomodate tip dimensions + pos.left -= offset.left.charAt ? offset.user : horizontal !== SHIFT || shift.top || !shift.left && !shift.top ? offset.left : 0; + pos.top -= offset.top.charAt ? offset.user : vertical !== SHIFT || shift.left || !shift.left && !shift.top ? offset.top : 0; + + // Cache details + cache.cornerLeft = adjust.left; cache.cornerTop = adjust.top; + cache.corner = newCorner.clone(); + }, + + destroy: function() { + // Unbind events + this.qtip._unbind(this.qtip.tooltip, this._ns); + + // Remove the tip element(s) + if(this.qtip.elements.tip) { + this.qtip.elements.tip.find('*') + .remove().end().remove(); + } + } +}); + +TIP = PLUGINS.tip = function(api) { + return new Tip(api, api.options.style.tip); +}; + +// Initialize tip on render +TIP.initialize = 'render'; + +// Setup plugin sanitization options +TIP.sanitize = function(options) { + if(options.style && 'tip' in options.style) { + opts = options.style.tip; + if(typeof opts !== 'object') { opts = options.style.tip = { corner: opts }; } + if(!(/string|boolean/i).test(typeof opts.corner)) { opts.corner = TRUE; } + } +}; + +// Add new option checks for the plugin +CHECKS.tip = { + '^position.my|style.tip.(corner|mimic|border)$': function() { + // Make sure a tip can be drawn + this.create(); + + // Reposition the tooltip + this.qtip.reposition(); + }, + '^style.tip.(height|width)$': function(obj) { + // Re-set dimensions and redraw the tip + this.size = size = [ obj.width, obj.height ]; + this.update(); + + // Reposition the tooltip + this.qtip.reposition(); + }, + '^content.title|style.(classes|widget)$': function() { + this.update(); + } +}; + +// Extend original qTip defaults +$.extend(TRUE, QTIP.defaults, { + style: { + tip: { + corner: TRUE, + mimic: FALSE, + width: 6, + height: 6, + border: TRUE, + offset: 0 + } + } +}); + +;PLUGINS.viewport = function(api, position, posOptions, targetWidth, targetHeight, elemWidth, elemHeight) +{ + var target = posOptions.target, + tooltip = api.elements.tooltip, + my = posOptions.my, + at = posOptions.at, + adjust = posOptions.adjust, + method = adjust.method.split(' '), + methodX = method[0], + methodY = method[1] || method[0], + viewport = posOptions.viewport, + container = posOptions.container, + cache = api.cache, + tip = api.plugins.tip, + adjusted = { left: 0, top: 0 }, + fixed, newMy, newClass; + + // If viewport is not a jQuery element, or it's the window/document or no adjustment method is used... return + if(!viewport.jquery || target[0] === window || target[0] === document.body || adjust.method === 'none') { + return adjusted; + } + + // Cache our viewport details + fixed = tooltip.css('position') === 'fixed'; + viewport = { + elem: viewport, + width: viewport[0] === window ? viewport.width() : viewport.outerWidth(FALSE), + height: viewport[0] === window ? viewport.height() : viewport.outerHeight(FALSE), + scrollleft: fixed ? 0 : viewport.scrollLeft(), + scrolltop: fixed ? 0 : viewport.scrollTop(), + offset: viewport.offset() || { left: 0, top: 0 } + }; + container = { + elem: container, + scrollLeft: container.scrollLeft(), + scrollTop: container.scrollTop(), + offset: container.offset() || { left: 0, top: 0 } + }; + + // Generic calculation method + function calculate(side, otherSide, type, adjust, side1, side2, lengthName, targetLength, elemLength) { + var initialPos = position[side1], + mySide = my[side], atSide = at[side], + isShift = type === SHIFT, + viewportScroll = -container.offset[side1] + viewport.offset[side1] + viewport['scroll'+side1], + myLength = mySide === side1 ? elemLength : mySide === side2 ? -elemLength : -elemLength / 2, + atLength = atSide === side1 ? targetLength : atSide === side2 ? -targetLength : -targetLength / 2, + tipLength = tip && tip.size ? tip.size[lengthName] || 0 : 0, + tipAdjust = tip && tip.corner && tip.corner.precedance === side && !isShift ? tipLength : 0, + overflow1 = viewportScroll - initialPos + tipAdjust, + overflow2 = initialPos + elemLength - viewport[lengthName] - viewportScroll + tipAdjust, + offset = myLength - (my.precedance === side || mySide === my[otherSide] ? atLength : 0) - (atSide === CENTER ? targetLength / 2 : 0); + + // shift + if(isShift) { + tipAdjust = tip && tip.corner && tip.corner.precedance === otherSide ? tipLength : 0; + offset = (mySide === side1 ? 1 : -1) * myLength - tipAdjust; + + // Adjust position but keep it within viewport dimensions + position[side1] += overflow1 > 0 ? overflow1 : overflow2 > 0 ? -overflow2 : 0; + position[side1] = Math.max( + -container.offset[side1] + viewport.offset[side1] + (tipAdjust && tip.corner[side] === CENTER ? tip.offset : 0), + initialPos - offset, + Math.min( + Math.max(-container.offset[side1] + viewport.offset[side1] + viewport[lengthName], initialPos + offset), + position[side1] + ) + ); + } + + // flip/flipinvert + else { + // Update adjustment amount depending on if using flipinvert or flip + adjust *= (type === FLIPINVERT ? 2 : 0); + + // Check for overflow on the left/top + if(overflow1 > 0 && (mySide !== side1 || overflow2 > 0)) { + position[side1] -= offset + adjust; + newMy.invert(side, side1); + } + + // Check for overflow on the bottom/right + else if(overflow2 > 0 && (mySide !== side2 || overflow1 > 0) ) { + position[side1] -= (mySide === CENTER ? -offset : offset) + adjust; + newMy.invert(side, side2); + } + + // Make sure we haven't made things worse with the adjustment and reset if so + if(position[side1] < viewportScroll && -position[side1] > overflow2) { + position[side1] = initialPos; newMy = my.clone(); + } + } + + return position[side1] - initialPos; + } + + // Set newMy if using flip or flipinvert methods + if(methodX !== 'shift' || methodY !== 'shift') { newMy = my.clone(); } + + // Adjust position based onviewport and adjustment options + adjusted = { + left: methodX !== 'none' ? calculate( X, Y, methodX, adjust.x, LEFT, RIGHT, WIDTH, targetWidth, elemWidth ) : 0, + top: methodY !== 'none' ? calculate( Y, X, methodY, adjust.y, TOP, BOTTOM, HEIGHT, targetHeight, elemHeight ) : 0 + }; + + // Set tooltip position class if it's changed + if(newMy && cache.lastClass !== (newClass = NAMESPACE + '-pos-' + newMy.abbrev())) { + tooltip.removeClass(api.cache.lastClass).addClass( (api.cache.lastClass = newClass) ); + } + + return adjusted; +};;})); +}( window, document )); + + diff --git a/contrib/libxo/xohtml/xohtml.1 b/contrib/libxo/xohtml/xohtml.1 new file mode 100644 index 000000000000..7ae12ddbde1d --- /dev/null +++ b/contrib/libxo/xohtml/xohtml.1 @@ -0,0 +1,103 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt XOHTML 1 +.Os +.Sh NAME +.Nm xohtml +.Nd display libxo html output +.Xr xo_emit 3 +.Sh SYNOPSIS +.Nm xohtml +.Op Fl "b <base>" +.Op Fl "c" <command>" +.Op Fl "f" <output> +.Op Fl "w" +.Op Ar command [argument ...] +.Sh DESCRIPTION +.Nm +is a tool for preparing +.Xr libxo 3 +HTML output for display in modern HTML web browsers. +.Nm +can operate in two modes. +If command is provided +either with the +.Fl c +option or as argument(s) to the +.Nm +command, that command is executed and the resulting output is processed. +If no command is given, the +standard input is used. +.Pp +.Nm +is typically used to wrap +.Nm libxo +output with sufficient HTML content to allow display in a web browser. +This includes parent HTML tags as well as +.Nm CSS +stylesheets and +.Nm Javascript +files. +.Pp +If the command is given directly on the command line, +.Nm +will add the "--libxo=html" option needed to generate HTML output +from +.Nm libxo "-enabled" +applications. See +.Xr xo_options 7 +for details. +.Pp +The following options are available: +.Bl -tag -width indent +.It Ic -b Ar base | Ic --base Ar base +Supplies a source path for the CSS and Javascript files referenced in +the output of +.Nm xohtml . +.It Ic -c Ar command | Ic --command Ar command +Use the given command instead of one on the command line. +This command should be quoted if it consists of multiple tokens, and +should contain the "--libxo=html" option or equivalent, since the +command is used directly. +.It Ic -f Ar file | Ic --file Ar file +Output is saved to the given file, rather than to the standard output +descriptor. +.It Ic -w | --web +Uses the official +.Nm libxo +website URL as the source path for the CSS and Javascript files +referenced in the output of +.Nm xohtml . +.El +.Pp +.Sh EXAMPLES +The following command line will run "du --libxo=html ~/src" and save +the output to /tmp/src.html: +.Bd -literal -offset indent + xohtml du ~/src > /tmp/src.html +.Ed +.Pp +The following command line will run "du --libxo=html,warn ~/src" and save +the output to /tmp/src.html: +.Bd -literal -offset indent + du --libxo=html,warn ~/src | xohtml -f /tmp/src.html +.Ed +.Pp +The following command line will run "du --libxo=html,warn ~/src" and save +the output to /tmp/src.html: +.Bd -literal -offset indent + xohtml -c "du --libxo=html,warn ~/src" -f /tmp/src.html +.Ed +.Pp +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xo_emit 3 , +.Xr xo_options 7 diff --git a/contrib/libxo/xohtml/xohtml.css b/contrib/libxo/xohtml/xohtml.css new file mode 100644 index 000000000000..67c3bff1b18a --- /dev/null +++ b/contrib/libxo/xohtml/xohtml.css @@ -0,0 +1,1040 @@ +/* + * $Id$ + * + * Copyright 2000, All rights reserved + * See ../Copyright for more information + */ + +#content-wrapper { + margin: 0 4px; +} + +#target-history .empty { + color: #d0d0d0; + text-align:center; +} + +#command-history .empty { + color: grey; + padding-left: 20px; +} + +#prefs { + font-size: 70%; +} + +div[data-key] { + color: red; +} + +div.decoration, div.default, div.header-line { + color: #505050; + font-family: monospace; + white-space: pre-wrap; +} + +div.line:first-child { + padding-top: 10px; +} + +div.padding { + white-space: pre-wrap; + font-family: monospace; + display: inline; +} + +div.label, div.note, div.text { + font-family: monospace; + white-space: pre-wrap; + display: inline; + vertical-align: middle; +/* + * font-weight: bold; + * color: #606060; + */ +} + +div.blank-line { + padding-top: 40px; +} + +div.title { + border-bottom: 2px solid black; + border-top: 2px solid #f0f0ff; + border-radius: 3px; + margin-top: 10px; + color: #1010a0; + background-color: #e0e0ff; + font-family: monospace; + display: inline; + vertical-align: middle; + white-space: pre-wrap; +} + +div.data { + font-family: monospace; +} + +div.line { + display: block; +} + +div.indented { + display: inline; +} + +div.indent { + display: inline; +} + +/* BEGIN LINES */ +div.line { + border: none; +} + +div.item { + border: none; +} + +div.pad { + border: none; +} + +div.blank-line { + border: 1px inset; +} + +div.item { + white-space: pre; +} +/* END LINES */ + +div.muxer-prompt { + padding: 2em; +} + +div.muxer-message, div.muxer-prompt form { + white-space: pre; + display: inline-block; + vertical-align: middle; +} + +div.muxer-buttons { + display: inline-block; + padding: 20px; +} + +div.text, div.decoration, div.data, div.header, div.pad, div.item, div.units { + font-family: monospace; + display: inline; + vertical-align: middle; + white-space: pre-wrap; +} + +div.blank-line { + margin: 5px; +} + +div.indentxxx { + padding-left: 2em; +} + +div.output, configuration-output, configuration-information { + font-family: monospace; + white-space: pre-wrap; +} + +div.header-line { + color: #ffffff; + background: none repeat scroll 0 0 #0D5995; + margin-top: 4px; + padding-top: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; +} + +div.header-line-empty { + color: #ffffff; + background: none repeat scroll 0 0 #0D5995; + padding-top: 4px; + padding-bottom: 2px; +} + + +/* + * juise rendering + */ + +div.hidden, +img.hidden, +button.hidden { + display: none; +} + +div.keeper-active div.icon-box img.keeper { + border: 1px solid #966535; + border-radius: 4px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; +} + +div.icon-box img.keeper { + border: 1px solid #ffffff; + border-radius: 4px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; +} + +div#debug-container { + background-color: #ccc; + border: 1px solid #d0d0ff; + bottom: 0; + color: blue; + display: none; + font-size: 70%; + position: fixed; + width: 100%; +} + +div#debug-log { + background-color: #ffffff; + max-height: 200px; + overflow-y: auto; + padding: 0 5px; + white-space: pre-wrap; +} + +div#header { + height: 30px; + padding: 0px 0px 40px 30px ; +} + +div#header-logo { + display: inline-block; + background: url(/images/logo.png) no-repeat; + height: 60px; + width: 150px; +} + +div#header-info { + display: table-cell; + height: 60px; + width: 60%; + background-color: #ffffff; + font-size: 80%; + padding-left: 10px; +} + +.prefsbtn { + background: rgb(230, 230, 230) url(/images/gear.png) no-repeat center; + margin-top: 5px; + min-height: 40px; + width: 40px; + border-radius: 2px; + cursor: pointer; + float: right; + box-shadow: 0 1px 1px #fff, + 0 -1px 1px #666, + inset 0 -1px 1px rgba(0,0,0,0.5), + inset 0 1px 1px rgba(255,255,255,0.8); +} + +.prefsbtn:hover { + background-color: #dde; +} + +div#header-actions { + height: 60px; + width: 200px; + display: table-cell; + padding-left: 10px; +} + +xdiv#header-actions div, +xdiv#header-info div { + display: inline-block; +} + +div#target-list { + display: none; + clear: both; +} + +div#target-title { + display: table-cell; + padding: 6px 1px 6px 0px; +} + +div#target-history { + border: 1px solid #659635; + position: absolute; + width: 25%; + padding-left: 0px; + padding-right: 0px; +} + +form#target-history-form { + margin-bottom: 0px; +} + +input#target-history-submit { + background: url(none); + margin-left: 2px; +} + +div.target-history-name { + display: inline-block; +} + +div.target-history-entry-parent:hover { + background: #659635; +} + +div.target-history-entry-parent:first-child { + border-top: 0px none; +} + +div.target-history-entry-parent { + border-top: 1px solid #659635; + padding-left: 8px; + padding-right: 8px; +} +div.target-history-entry { + display: inline-block; +} + +div.target-info { + display: inline-block; + font-family: Helvetica, Arial, sans-serif; + font-weight: bold; + font-size: 12px; + margin-right: 10px; + margin-left: 10px; + padding: 5px 10px 5px 10px; +} + +div#target-contents, +div#target-contents-none { + display: table-cell; + font-family: Verdana, Arial, Helvetica, sans-serif ; +} + +div#target-contents-none { + padding-left: 10px; + font-size: 70%; +} + +div.target { + display: inline-block; + margin-left: 2px; + margin-right: 2px; +} + +div#command-history { + border: 1px solid #c0c0ff; + position: absolute; + width: 60em; + font-family: Verdana, Arial, Helvetica, sans-serif ; + font-family: monospace; + font-size: 12px; + background: #e0e0ff; + padding-left: 0px; + padding-right: 0px; +} + +div.command-history-entry:hover { + background: #c0c0ff; +} + +div.command-history-entry:first-child { + border-top: 0px none; +} + +div.command-history-entry { + border-top: 1px solid #c0c0ff; + padding-left: 8px; + padding-right: 8px; +} + +div#footer { + padding-top: 100px; + clear: both; + display: block; + height: 100px; + width: 100%; + font-size: 8; + text-align: center; +} + +div#input-history { + display: inline-block; + float: left; + margin-right: 5px; + position: relative; + width: 70%; +} + +div#input-top { + display: block; + height: 70px; + padding: 10px; + margin-bottom: 10px; + background-color: rgb(245, 245, 245); + border-bottom: rgb(200, 200, 200) solid 1px; + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1); +} + +div#input-history .pulldown { + border: solid 1px rgb(180, 180, 200); + max-height: 300px; + overflow-y: auto; + padding: 0px; + width: 100%; +} + +div#mru-pulldown { + margin-top: 40px; + position: absolute; + width: 100%; + z-index: 9999; +} + +div#mru-pulldown .mru-item { + padding: 5px; +} + +div#mru-pulldown .mru-item:hover { + background: rgb(242, 244, 255); + cursor: pointer; + font-weight: 700; +} + +div#recent-devices { + margin-top: 10px; +} + +div#recent-devices a { + color: rgb(0, 50, 112); + cursor: pointer; + text-decoration: underline; +} + +div#input-top .logo { + float: left; + margin: 0px 10px 0px 10px; +} + +form#target-input-form, +form#command-input-form { + display: inline-block; +} + +div#target-top, +div#command-top { + display: inline-block; + float: left; + margin: 10px 5px 0px 0px; + width: 100%; +} + +div#command-top .input-box { + height: 32px; + min-width: 500px; + padding: 1px; + background-color: #fff; + width: 100%; +} + +div#command-top .focus-off { + border: solid 1px rgb(180, 180, 200); +} + +div#command-top .focus-on { + border: solid 1px rgb(180, 180, 200); + box-shadow: 0px 0px 8px rgba(100, 100, 200, 0.5); +} + +div#input-top .input-enter { + margin: 10px 0px 10px 0px; + float: left; +} + +input.command-input { + font-family: Verdana, Arial, Helvetica, sans-serif ; + font-family: monospace; + font-size: 12px; +} + +div#output-top { + margin-bottom: 20px; +} + +div.output-wrapper { +/* border: 1px solid blue; */ + margin-top: 5px; + background: white; + padding: 0px; +} + +div.output-header button { + margin-right: 4px; +} + +div.output-header { + padding: 4px; +} + +div.output-header div.target-value { + margin-left: 4px; +} + +div.output-header div.command-value { + margin-right: 4px; +} + +div.output-header div.target-value, +div.output-header div.command-value { + font-weight: normal; + font-size: 12px; +} + +div.target-value, +input.target-value { + display: inline-block; + font-size: 12px; + font-family: Verdana, Arial, Helvetica, sans-serif ; +} + +div.label, div.note { + display: inline; +/* + padding-left: 3px; + padding-right: 3px; +*/ + font-size: 12px; +} + +div.command-value, +input.command-value { + display: inline-block; + font-size: 14px; +} + +div.command-number { + display: inline-block; + font-size: 70%; + float: right; +} + +div#ember-view .output-content { + float: left; + position: relative; +} + +div.output-content { + display: block; + font-size: 12px; + padding: 10px; +} + +div.icon-box { + display: inline-block; + margin-right: 5px; +} + +div#debug-title { + display: inline-block; +} + +img.icon { + height: 16px; + vertical-align: middle; +} + +.buttonish { + text-align: center; + text-decoration: none; + text-shadow: -1px -1px 2px #777777; + text-shadow: rgba(10, 10, 10, 0.5) 1px 2px 2px; +} + +input.text-entry { + border: 0; + outline: 0; + height: 20px; + width: 100%; +} + +.rounded { + border: 1px solid #659635; + background: #99ca28; + padding: 2px 8px 2px 8px; + + border-radius: 5px; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; +} + +.green { + color: #ffffff; + background: linear-gradient(top, + #5da331 0%, #659635 2%, #9bcb2a 97%, #cfe782 100%); + background: -moz-linear-gradient(top, + #5da331 0%, #659635 2%, #9bcb2a 97%, #cfe782 100%); + background: -webkit-linear-gradient(top, + #5da331 0%, #659635 2%, #9bcb2a 97%, #cfe782 100%); + filter: progid:DXImageTransform.Microsoft.gradient(GradientType=0, + startColorstr='#659635', endColorstr='#9bcb2a'); +} + +.blue { + color: #0c0c0c; +/* + background: linear-gradient(top, + #a0a0ff 0%, #c8c8ff 10%, #d8d8ff 90%, #f0f0ff 100%); + background: -moz-linear-gradient(top, + #a0a0ff 0%, #c8c8ff 10%, #d8d8ff 90%, #f0f0ff 100%); + background: -webkit-linear-gradient(top, + #a0a0ff 0%, #c8c8ff 10%, #d8d8ff 90%, #f0f0ff 100%); + filter: progid:DXImageTransform.Microsoft.gradient(GradientType=0, + startColorstr='#a0a0ff', endColorstr='#f0f0ff'); +*/ +} + +.jquery-checkbox { + line-height: 24px; +} + +ul.setupgrid { + padding: 0; + list-style: none; + margin: 0 auto; +} + +ul.setupgrid li { + float: left; + padding: 10px; + border: 1px solid #cbcad0; + margin: 0 5px 10px 5px; +} + +div.setupgrid { + font-family: 'GraublauWeb', arial, serif; + text-align: center; +} + +.setupgrid a { + height: 32px; + width: 64px; + display: block; + padding-top: 32px; + text-decoration: none; +} + +.setupgrid a#prefs-devices { + background: url(/images/prefs-devices.png) no-repeat center top; +} + +.setupgrid a#prefs-groups { + background: url(/images/prefs-groups.png) no-repeat center top; +} + +.setupgrid a#prefs-general { + background: url(/images/prefs-general.png) no-repeat center top; +} + +div.input { + background: #e0e0ff; + padding: 10px; +} + +div.parse { + background: #b0b0b0; + border: 1px solid black; +} + +div.input-debug { + background: #ffe0e0; + border-bottom: 1px solid black; + padding: 10px; + font-weight: bold; +} + +div.possibility-debug { + background: #ffe0e0; + padding: 10px; + border-bottom: 1px dotted red; +} + +div.match-debug { + display: inline-block; + padding: 5px; +} + +div.command-token, +div.command-token div { + display: inline-block; +} + +div.parse-details { +/* display: none; */ +} + +div.command-line { + font-weight: bold; +} + +div.match-details { + display: inline-block; +} + +div.possibility { +/* background: #ffe0e0; */ + padding: 10px; + border-bottom: 1px dotted red; +} + +div.parse-implicit-keyword, +div.parse-token, +div.parse-trailing, +div.parse-missing { + display: inline-block; +} + +div.parse-implicit-keyword, +div.parse-trailing, +div.parse-missing { + font-style: italic; + font-weight: normal; +} + +div.parse-token { + font-weight: bold; +} + +div.parse-mandatory { + color: red; + display: inline-block; +} + +div.parse-mandatory-value { + color: red; + font-style: italic; + display: inline-block; +} + +div.output-content div.parse:first-of-type { + display: none; +} + +div.command-help { + font-size: smaller; + font-style: italic; + padding-left: 20px; + padding-bottom: 5px; +} + +img.rendered { + float: left; + margin-right: 5px; + max-width: 16px; + vertical-align: middle; +} + +div.map-small { + width: 300px; + height: 200px; +} + +div.inline-dialog { + box-shadow: none; + margin-left: 20px; + position: relative; +} + +.inline-dialog .ui-dialog-titlebar-close { + display: none; +} + +div#prefs-title { + font-size: 120%; + font-weight: 600; +} + +div.prefs-item, +div.ui-yf-item { + display: table-row; +} + +div.prefs-item label, +div.ui-yf-item label { + padding-left: 10px; + padding-right: 5px; +} + +div.prefs-item label, +div.prefs-item input, +div.prefs-item div, +div.ui-yf-item label, +div.ui-yf-item input, +div.ui-yf-item div { + display: table-cell; +} + +div.dyn-form { + padding: 5px; + width: auto; +} + +div.dyn-form-wrapper { + display: inline-block; + border: 1px solid #ccc; + min-width: 400px; +} + +div.dyn-form-title { + background-color: #1478dc; + padding: 10px; + color: white; + font-size: 1.1em; +} + +div.dyn-form-item { + display: inline-block; + text-align: center; + padding: 2px 10px 2px 10px; +} + +div.dyn-form-message { + text-align: left; + padding: 5px 10px 5px 10px; +} + +div.dyn-form-item label { + float: left; + padding-left: 10px; + padding-right: 5px; +} + +div.dyn-form-buttons { + text-align: center; + padding: 5px 10px 10px 10px; +} + +div.dyn-form-item label, +div.dyn-form-item input, +div.dyn-form-item select, +div.dyn-form-item div { + float: left; + line-height: 20px; + margin-top: 5px; + min-width: 100px; + text-align: left; +} + +div.dyn-form-item input, +div.dyn-form-item select { + border: solid 1px #CCC; + margin-top: 5px; + width: auto; +} + +div.dyn-form-item .mandatory { + border-color: rgb(213, 119, 0); +} + +div.dyn-form-item .is-error { + border-color: rgb(213, 11, 0); +} + +div.dyn-form-item .is-error:focus { + border-color: rgb(213, 11, 0); +} + +div.dyn-form-item input:focus { + border: solid 1px rgb(180, 180, 200); + box-shadow: 0px 0px 3px rgba(100, 100, 200, 0.8); +} + +div.dyn-form-boolean { + margin-left: -40px; + text-align: left; + vertical-align: middle; +} + +div.dyn-form-item .dyn-radio-button { + margin-left: -30px; + margin-right: -40px; +} + +div.dyn-radiogroup { + border-bottom: 1px solid rgb(230, 230, 230); + border-top: 1px solid rgb(230, 230, 230); + padding: 5px; +} + +.dyn-dropdown-item { + max-height: 200px; + overflow-y: auto; +} + +.history-element .command { + font-size: 16px; +} + +.history-element .date { + color: rgb(130, 130, 130); + font-style: italic; +} + +.node { + stroke: #fff; + stroke-width: 1.5px; +} + +.link { + stroke: #444; + stroke-opacity: 0.6; + stroke-width: 2px; +} + +g.node text { + pointer-events: none; + font: 8px; + stroke: #000080; +} + +some.day { + background: -moz-linear-gradient(center top , #4B90C3, #0D63A3) + repeat scroll 0 0 transparent; +} + +.ui-autocomplete-divider { + border-bottom: 1px solid black; +} + +.ui-autocomplete { + max-height: 400px; + overflow-y: auto; + overflow-x: hidden; + padding-right: 20px; + width: 650px; +} + +ul.ui-autocomplete li.ui-menu-item { + font-family: monospace; +} + +ul.ui-autocomplete li.ui-menu-item a.label { + float: left; + font-weight: bold; +} + +ul.ui-autocomplete li.ui-menu-item a.help { + float: right; +} + +a.xpath-link { + text-decoration: none; +} + +div.xpath-wrapper { + margin-top: 8px; + padding-top: 5px; + border-top: solid 1px #c8c8c8; +} + +div.xpath { + display: none; + margin-top: 8px; +} + +/* + * Additional styles for messages + */ +.ui-state-info { + color: rgb(0, 94, 196); +} + +.ui-state-info .ui-icon { + background-image:url(/themes/clira/images/ui-icons_ffcf29_256x240.png); +} + +.ui-state-success { + color: rgb(45, 126, 0); +} + +.ui-state-success .ui-icon { + background-image:url(/themes/clira/images/ui-icons_ffcf29_256x240.png); +} + +.ui-state-warning { + color: rgb(179, 146, 14); +} + +.ui-state-warning .ui-icon { + background-image:url(/themes/clira/images/ui-icons_ffcf29_256x240.png); +} + +.stop_button { + background-color: #f24537; + background: -moz-linear-gradient( center top, #f24537 5%, #c62d1f 100% ); + background: -webkit-gradient( linear, left top, left bottom, color-stop(0.05, #f24537), color-stop(1, #c62d1f) ); + border: 1px solid #d02718; + border-bottom-left-radius: 6px; + border-bottom-right-radius: 6px; + border-top-left-radius: 6px; + border-top-right-radius: 6px; + box-shadow: inset 0px 1px 0px 0px #f5978e; + color: #ffffff; + display: inline-block; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#f24537', endColorstr='#c62d1f'); + font-family: Courier New; + font-size: 10px; + font-style: normal; + font-weight: bold; + height: 16px; + line-height: 16px; + margin-left: 5px; + text-align: center; + text-decoration: none; + text-indent: 0.4px; + text-shadow: 1px 1px 0px #810e05; + width: 37px; +} + +.stop_button:hover { + background-color: #c62d1f; + background: -moz-linear-gradient( center top, #c62d1f 5%, #f24537 100% ); + background: -webkit-gradient( linear, left top, left bottom, color-stop(0.05, #c62d1f), color-stop(1, #f24537) ); + filter:progid: DXImageTransform.Microsoft.gradient(startColorstr='#c62d1f', endColorstr='#f24537'); +} + +.stop_button:active { + position: relative; + top: 1px; +} + +div.color-fg-black { color: black; } +div.color-fg-red { color: red; } +div.color-fg-green { color: green; } +div.color-fg-yellow { color: yellow; } +div.color-fg-blue { color: blue; } +div.color-fg-magenta { color: magenta; } +div.color-fg-cyan { color: cyan; } +div.color-fg-white { color: white; } + +div.color-bg-black { background-color: black; } +div.color-bg-red { background-color: red; } +div.color-bg-green { background-color: green; } +div.color-bg-yellow { background-color: yellow; } +div.color-bg-blue { background-color: blue; } +div.color-bg-magenta { background-color: magenta; } +div.color-bg-cyan { background-color: cyan; } +div.color-bg-white { background-color: white; } + +div.color-fg-inverse { color: white; } +div.color-bg-inverse { background-color: black; } + +div.effect-bold { font-weight:bold; } +div.effect-underline { text-decoration: underline; } diff --git a/contrib/libxo/xohtml/xohtml.js b/contrib/libxo/xohtml/xohtml.js new file mode 100644 index 000000000000..9e3d836d23ab --- /dev/null +++ b/contrib/libxo/xohtml/xohtml.js @@ -0,0 +1,54 @@ +jQuery(function($) { + setTimeout(function() { + var $top = $("html body"); + $top.find('[class~="data"]').each(function() { + var help = $(this).attr('data-help'), + type = $(this).attr('data-type'), + xpath = $(this).attr('data-xpath'), + tag = $(this).attr('data-tag'), + output = ""; + if (help) { + output += "<b>Help</b>: " + help + "<br/>"; + } + if (type) { + output += "<b>Type</b>: " + type + "<br/>"; + } + if (xpath) { + output += "<div class='xpath-wrapper'>" + + "<a class='xpath-link' href='#'>" + + "show xpath</a><div class='xpath'>" + + xpath + "</div></div><br/>"; + } + if (output.length > 0) { + output = "<div>" + output + "</div>"; + } + + $(this).qtip({ + content: { + title: "<b>" + tag + "</b>", + text: function () { + var div = $(output); + div.find(".xpath-link") + .click(function() { + var xpath = $(this).next(); + if (xpath.is(":hidden")) { + xpath.show(); + $(this).text("hide xpath"); + } else { + xpath.hide(); + $(this).text("show xpath"); + } + return false; + }); + return div; + } + }, + hide: { + fixed: true, + delay: 300 + }, + style: "qtip-tipped" + }); + }); + }, 0); +});
\ No newline at end of file diff --git a/contrib/libxo/xohtml/xohtml.sh.in b/contrib/libxo/xohtml/xohtml.sh.in new file mode 100644 index 000000000000..aeb5d7baa806 --- /dev/null +++ b/contrib/libxo/xohtml/xohtml.sh.in @@ -0,0 +1,85 @@ +#!/bin/sh +# +# Copyright (c) 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. +# Phil Shafer, July 2014 +# + +BASE=@XO_SHAREDIR@ +VERSION=@LIBXO_VERSION@ +CMD=cat +DONE= +WEB=http://juniper.github.io/libxo/${VERSION}/xohtml + +do_help () { + echo "xohtml: wrap libxo-enabled output in HTML" + echo "Usage: xohtml [options] [command [arguments]]" + echo "Valid options are:" + echo " -b <basepath> | --base <basepath>" + echo " -c <command> | --command <command>" + echo " -f <output-file> | --file <output-file>" + exit 1 +} + +while [ -z "$DONE" -a ! -z "$1" ]; do + case "$1" in + -b|--base) + shift; + BASE="$1"; + shift; + ;; + -c|--command) + shift; + CMD="$1"; + shift; + ;; + -f|--file) + shift; + FILE="$1"; + shift; + exec > "$FILE"; + ;; + -w|--web) + shift; + BASE="${WEB}"; + ;; + + -*) + do_help + ;; + *) + DONE=1; + XX=$1; + shift; + CMD="$XX --libxo=html $@" + ;; + esac +done + +if [ "$CMD" = "cat" -a -t 0 ]; then + do_help +fi + +echo '<html>' +echo '<head>' +echo '<meta http-equiv="content-type" content="text/html; charset=utf-8"/>' +echo '<link rel="stylesheet" href="'$BASE'/xohtml.css">' +echo '<link rel="stylesheet" href="'$BASE'/external/jquery.qtip.css"/>' +echo '<script type="text/javascript" src="'$BASE'/external/jquery.js"></script>' +echo '<script type="text/javascript" src="'$BASE'/external/jquery.qtip.js"></script>' +echo '<script type="text/javascript" src="'$BASE'/xohtml.js"></script>' +echo '<script>' +echo '</script>' +echo '</head>' +echo '<body>' + +$CMD + +echo '</body>' +echo '</html>' + +exit 0 diff --git a/contrib/libxo/xolint/Makefile.am b/contrib/libxo/xolint/Makefile.am new file mode 100644 index 000000000000..10e9759f422e --- /dev/null +++ b/contrib/libxo/xolint/Makefile.am @@ -0,0 +1,21 @@ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +man_MANS = xolint.1 + +EXTRA_DIST = xolint.1 xolint.pl + +install-exec-hook: + install ${srcdir}/xolint.pl ${DESTDIR}${bindir}/xolint + +uninstall-hook: + rm -f ${DESTDIR}${bindir}/xolint + +install-data-hook: + for file in ${man_MANS}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man1dir}/$$file ; done diff --git a/contrib/libxo/xolint/xolint.1 b/contrib/libxo/xolint/xolint.1 new file mode 100644 index 000000000000..247536f33b00 --- /dev/null +++ b/contrib/libxo/xolint/xolint.1 @@ -0,0 +1,89 @@ +.\" # +.\" # Copyright (c) 2014, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt XOLINT 1 +.Os +.Sh NAME +.Nm xolint +.Nd detect errors in programs using +.Xr xo_emit 3 +.Sh SYNOPSIS +.Nm xolint +.Op Fl c +.Op Fl "C <flags>" +.Op Fl "d" +.Op Fl "D" +.Op Fl "I" +.Op Fl "p" +.Op Fl "V" +.Op Fl "X" +.Op Ar files... +.Sh DESCRIPTION +.Nm +is a tool for reporting common mistakes in format strings +in source code that invokes +.Xr xo_emit 3 . +It allows these errors +to be diagnosed at build time, rather than waiting until runtime. +.Pp +.Nm +takes one or more C files as arguments, and reports +error, warning, or informational messages as needed. +.Bl -tag -width "C <flags>" +.It Fl c +Invoke 'cpp' against the input file +.It Fl "C <flags>" +Flags that are passed to 'cpp' +.It Fl "d" +Enable debug output +.It Fl "D" +Generate documentation for all +.Nm +messages +.It Fl "I" +Generate a table of +.Dv xo_info_t +structures. +.It Fl "p" +Print the offending lines after the error message is displayed +.It Fl "V" +Do not report errors, but instead print a complete list of +all field names, sorted alphabetically. +The output can help spot +inconsistencies and spelling errors. +.It Fl "X" +Extract samples from +.Nm , +suitable for internal testing. +.El +.Pp +The output message contains the source filename and line number, the +class of the message, the message, and, if +.Fl p +is given, the +line that contains the error: +.Bd -literal -offset indent + % xolint -t xolint.c + xolint.c: 16: error: anchor format should be "%d" + 16 xo_emit("{[:/%s}"); +.Ed +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xo_emit 3 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/xolint/xolint.pl b/contrib/libxo/xolint/xolint.pl new file mode 100644 index 000000000000..0d2be9384181 --- /dev/null +++ b/contrib/libxo/xolint/xolint.pl @@ -0,0 +1,701 @@ +#!/usr/bin/env perl +# +# Copyright (c) 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. +# Phil Shafer, August 2014 +# +# +# xolint -- a lint for inspecting xo_emit format strings +# +# Yes, that's a long way to go for a pun. + +%vocabulary = (); + +sub main { + while ($ARGV[0] =~ /^-/) { + $_ = shift @ARGV; + $opt_cpp = 1 if /^-c/; + $opt_cflags .= shift @ARGV if /^-C/; + $opt_debug = 1 if /^-d/; + extract_docs() if /^-D/; + $opt_info = $opt_vocabulary = 1 if /^-I/; + $opt_print = 1 if /^-p/; + $opt_vocabulary = 1 if /^-V/; + extract_samples() if /^-X/; + } + + if ($#ARGV < 0) { + print STDERR "xolint [options] files ...\n"; + print STDERR " -c invoke 'cpp' on input\n"; + print STDERR " -C flags Pass flags to cpp\n"; + print STDERR " -d Show debug output\n"; + print STDERR " -D Extract xolint documentation\n"; + print STDERR " -I Print xo_info_t data\n"; + print STDERR " -p Print input data on errors\n"; + print STDERR " -V Print vocabulary (list of tags)\n"; + print STDERR " -X Print examples of invalid use\n"; + exit(1); + } + + for $file (@ARGV) { + parse_file($file); + } + + if ($opt_info) { + print "static xo_info_t xo_info_table[] = {\n"; + for $name (sort(keys(%vocabulary))) { + print " { \"", $name, "\", \"type\", \"desc\" },\n"; + } + print "};\n"; + print "static int xo_info_count = " + . "(sizeof(xo_info_table) / sizeof(xo_info_table[0]));\n\n"; + print "#define XO_SET_INFO() \\\n"; + print " xo_set_info(NULL, xo_info_table, xo_info_count)\n"; + } elsif ($opt_vocabulary) { + for $name (sort(keys(%vocabulary))) { + print $name, "\n"; + } + } +} + +sub extract_samples { + my $x = "\#" . "\@"; + my $cmd = "grep -B1 -i '$x Should be' $0 | grep xo_emit | sed 's/.*\#*\@//'"; + system($cmd); + exit(0); +} + +sub extract_docs { + my $x = "\#" . "\@"; + my $cmd = "grep -B1 '$x' $0"; + open INPUT, "$cmd |"; + local @input = <INPUT>; + close INPUT; + my $ln, $new = 0, $first = 1, $need_nl; + + for ($ln = 0; $ln <= $#input; $ln++) { + chomp($_ = $input[$ln]); + if (/^--/) { + $ln += 1; + $new = 1; + next; + } + if ($first) { + $new = 1; + $first = 0; + next; + } + + s/\s*\#\@\s*//; + + if ($new) { + if ($need_nl) { + print "\n\n"; + $need_nl = 0; + } + + $under = "+" x (length($_) + 2); + + print "'$_'\n$under\n\n"; + print "The message \"$_\" can be caused by code like:\n"; + $new = 0; + + } elsif (/xo_emit\s*\(/) { + s/^\s+//; + print "\n::\n\n $_\n\n"; + + } elsif (/^Should be/i) { + print "This code should be replaced with code like:\n"; + + } else { + print "$_\n"; + $need_nl = 1; + } + } + + exit(0); +} + +sub parse_file { + local($file) = @_; + local($errors, $warnings, $info) = (0, 0, 0); + local $curfile = $file; + local $curln = 0; + + if ($opt_cpp) { + die "no such file" unless -f $file; + open INPUT, "cpp $opt_cflags $file |"; + } else { + open INPUT, $file || die "cannot open input file '$file'"; + } + local @input = <INPUT>; + close INPUT; + + local $ln, $rln, $line, $replay; + + for ($ln = 0; $ln < $#input; $ln++) { + $line = $input[$ln]; + $curln += 1; + + if ($line =~ /^\#/) { + my($num, $fn) = ($line =~ /\#\s*(\d+)\s+"(.+)"/); + ($curfile, $curln) = ($fn, $num) if $num; + next; + } + + next unless $line =~ /xo_emit\(/; + + @tokens = parse_tokens(); + print "token:\n '" . join("'\n '", @tokens) . "'\n" + if $opt_debug; + check_format($tokens[0]); + } + + print $file . ": $errors errors, $warnings warnings, $info info\n" + unless $opt_vocabulary; +} + +sub parse_tokens { + my $full = "$'"; + my @tokens = (); + my %pairs = ( "{" => "}", "[" => "]", "(" => ")" ); + my %quotes = ( "\"" => "\"", "'" => "'" ); + local @data = split(//, $full); + local @open = (); + local $current = ""; + my $quote = ""; + local $off = 0; + my $ch; + + $replay = $curln . " " . $line; + $rln = $ln + 1; + + for (;;) { + get_tokens() if $off > $#data; + die "out of data" if $off > $#data; + $ch = $data[$off++]; + + print "'$ch' ($quote) ($#open) [" . join("", @open) . "]\n" + if $opt_debug; + + last if $ch eq ";" && $#open < 0; + + if ($ch eq "," && $quote eq "" && $#open < 0) { + print "[$current]\n" if $opt_debug; + push @tokens, $current; + $current = ""; + next; + } + + next if $ch =~ /[ \t\n\r]/ && $quote eq "" && $#open < 0; + + $current .= $ch; + + if ($quote) { + if ($ch eq $quote) { + $quote = ""; + } + next; + } + if ($quotes{$ch}) { + $quote = $quotes{$ch}; + $current = substr($current, 0, -2) if $current =~ /""$/; + next; + } + + if ($pairs{$ch}) { + push @open, $pairs{$ch}; + next; + } + + if ($#open >= 0 && $ch eq $open[$#open]) { + pop @open; + next; + } + } + + push @tokens, substr($current, 0, -1); + return @tokens; +} + +sub get_tokens { + if ($ln + 1 < $#input) { + $line = $input[++$ln]; + $curln += 1; + $replay .= $curln . " " . $line; + @data = split(//, $line); + $off = 0; + } +} + +sub check_format { + my($format) = @_; + + return unless $format =~ /^".*"$/; + + my @data = split(//, $format); + my $ch; + my $braces = 0; + local $count = 0; + my $content = ""; + my $off; + my $phase = 0; + my @build = (); + local $last, $prev = ""; + + # Nukes quotes + pop @data; + shift @data; + + for (;;) { + last if $off > $#data; + $ch = $data[$off++]; + + if ($ch eq "\\") { + $ch = $data[$off++]; + $off += 1 if $ch eq "\\"; # double backslash: "\\/" + next; + } + + if ($braces) { + if ($ch eq "}") { + check_field(@build); + $braces = 0; + @build = (); + $phase = 0; + next; + } elsif ($phase == 0 && $ch eq ":") { + $phase += 1; + next; + } elsif ($ch eq "/") { + $phase += 1; + next; + } + + } else { + if ($ch eq "{") { + check_text($build[0]) if length($build[0]); + $braces = 1; + @build = (); + $last = $prev; + next; + } + $prev = $ch; + } + + $build[$phase] .= $ch; + } + + if ($braces) { + error("missing closing brace"); + check_field(@build); + } else { + check_text($build[0]) if length($build[0]); + } +} + +sub check_text { + my($text) = @_; + + print "checking text: [$text]\n" if $opt_debug; + + #@ A percent sign appearing in text is a literal + #@ xo_emit("cost: %d", cost); + #@ Should be: + #@ xo_emit("{L:cost}: {:cost/%d}", cost); + #@ This can be a bit surprising and could be a field that was not + #@ properly converted to a libxo-style format string. + info("a percent sign appearing in text is a literal") if $text =~ /%/; +} + +%short = ( + # Roles + "color" => "C", + "decoration" => "D", + "error" => "E", + "label" => "L", + "note" => "N", + "padding" => "P", + "title" => "T", + "units" => "U", + "value" => "V", + "warning" => "W", + "start-anchor" => "[", + "stop-anchor" => "]", + # Modifiers + "colon" => "c", + "display" => "d", + "encoding" => "e", + "hn" => "h", + "hn-decimal" => "@", + "hn-space" => "@", + "hn-1000" => "@", + "humanize" => "h", + "key" => "k", + "leaf-list" => "l", + "no-quotes" => "n", + "quotes" => "q", + "trim" => "t", + "white" => "w", + ); + +sub check_field { + my(@field) = @_; + print "checking field: [" . join("][", @field) . "]\n" if $opt_debug; + + if ($field[0] =~ /,/) { + # We have long names; deal with it by turning them into short names + my @parts = split(/,/, $field[0]); + my $new = ""; + for (my $i = 1; $i <= $#parts; $i++) { + my $v = $parts[$i]; + $v =~ s/^\s+//; + $v =~ s/\s+$//; + if ($short{$v} eq "@") { + # ignore; has no short version + } elsif ($short{$v}) { + $new .= $short{$v}; + } else { + #@ Unknown long name for role/modifier + #@ xo_emit("{,humanization:value}", value); + #@ Should be: + #@ xo_emit("{,humanize:value}", value); + #@ The hn-* modifiers (hn-decimal, hn-space, hn-1000) + #@ are only valid for fields with the {h:} modifier. + error("Unknown long name for role/modifier ($v)"); + } + } + + $field[4] = substr($field[0], index($field[0], ",")); + $field[0] = $parts[0] . $new; + } + + if ($opt_vocabulary) { + $vocabulary{$field[1]} = 1 + if $field[1] && $field[0] !~ /[DELNPTUW\[\]]/; + return; + } + + #@ Last character before field definition is a field type + #@ A common typo: + #@ xo_emit("{T:Min} T{:Max}"); + #@ Should be: + #@ xo_emit("{T:Min} {T:Max}"); + #@ Twiddling the "{" and the field role is a common typo. + info("last character before field definition is a field type ($last)") + if $last =~ /[DELNPTUVW\[\]]/ && $field[0] !~ /[DELNPTUVW\[\]]/; + + #@ Encoding format uses different number of arguments + #@ xo_emit("{:name/%6.6s %%04d/%s}", name, number); + #@ Should be: + #@ xo_emit("{:name/%6.6s %04d/%s-%d}", name, number); + #@ Both format should consume the same number of arguments off the stack + my $cf = count_args($field[2]); + my $ce = count_args($field[3]); + warn("encoding format uses different number of arguments ($cf/$ce)") + if $ce >= 0 && $cf >= 0 && $ce != $cf; + + #@ Only one field role can be used + #@ xo_emit("{LT:Max}"); + #@ Should be: + #@ xo_emit("{T:Max}"); + my(@roles) = ($field[0] !~ /([DELNPTUVW\[\]]).*([DELNPTUVW\[\]])/); + error("only one field role can be used (" . join(", ", @roles) . ")") + if $#roles > 0; + + # Field is a color, note, label, or title + if ($field[0] =~ /[CDLNT]/) { + + #@ Potential missing slash after C, D, N, L, or T with format + #@ xo_emit("{T:%6.6s}\n", "Max"); + #@ should be: + #@ xo_emit("{T:/%6.6s}\n", "Max"); + #@ The "%6.6s" will be a literal, not a field format. While + #@ it's possibly valid, it's likely a missing "/". + info("potential missing slash after C, D, N, L, or T with format") + if $field[1] =~ /%/; + + #@ An encoding format cannot be given (roles: DNLT) + #@ xo_emit("{T:Max//%s}", "Max"); + #@ Fields with the C, D, N, L, and T roles are not emitted in + #@ the 'encoding' style (JSON, XML), so an encoding format + #@ would make no sense. + error("encoding format cannot be given when content is present") + if $field[3]; + } + + # Field is a color, decoration, label, or title + if ($field[0] =~ /[CDLN]/) { + #@ Format cannot be given when content is present (roles: CDLN) + #@ xo_emit("{N:Max/%6.6s}", "Max"); + #@ Fields with the C, D, L, or N roles can't have both + #@ static literal content ("{L:Label}") and a + #@ format ("{L:/%s}"). + #@ This error will also occur when the content has a backslash + #@ in it, like "{N:Type of I/O}"; backslashes should be escaped, + #@ like "{N:Type of I\\/O}". Note the double backslash, one for + #@ handling 'C' strings, and one for libxo. + error("format cannot be given when content is present") + if $field[1] && $field[2]; + } + + # Field is a color/effect + if ($field[0] =~ /C/) { + if ($field[1]) { + my $val; + my @sub = split(/,/, $field[1]); + grep { s/^\s*//; s/\s*$//; } @sub; + + for $val (@sub) { + if ($val =~ /^(default,black,red,green,yellow,blue,magenta,cyan,white)$/) { + + #@ Field has color without fg- or bg- (role: C) + #@ xo_emit("{C:green}{:foo}{C:}", x); + #@ Should be: + #@ xo_emit("{C:fg-green}{:foo}{C:}", x); + #@ Colors must be prefixed by either "fg-" or "bg-". + error("Field has color without fg- or bg- (role: C)"); + + } elsif ($val =~ /^(fg|bg)-(default|black|red|green|yellow|blue|magenta|cyan|white)$/) { + # color + } elsif ($val =~ /^(bold|underline)$/) { + } elsif ($val =~ /^(no-)?(bold|underline|inverse)$/) { + # effect + + } elsif ($val =~ /^(reset|normal)$/) { + # effect also + } else { + #@ Field has invalid color or effect (role: C) + #@ xo_emit("{C:fg-purple,bold}{:foo}{C:gween}", x); + #@ Should be: + #@ xo_emit("{C:fg-red,bold}{:foo}{C:fg-green}", x); + #@ The list of colors and effects are limited. The + #@ set of colors includes default, black, red, green, + #@ yellow, blue, magenta, cyan, and white, which must + #@ be prefixed by either "fg-" or "bg-". Effects are + #@ limited to bold, no-bold, underline, no-underline, + #@ inverse, no-inverse, normal, and reset. Values must + #@ be separated by commas. + error("Field has invalid color or effect (role: C) ($val)"); + } + } + } + } + + # Humanized field + if ($field[0] =~ /h/) { + if (length($field[2]) == 0) { + #@ Field has humanize modifier but no format string + #@ xo_emit("{h:value}", value); + #@ Should be: + #@ xo_emit("{h:value/%d}", value); + #@ Humanization is only value for numbers, which are not + #@ likely to use the default format ("%s"). + error("Field has humanize modifier but no format string"); + } + } + + # hn-* on non-humanize field + if ($field[0] !~ /h/) { + if ($field[4] =~ /,hn-/) { + #@ Field has hn-* modifier but not 'h' modifier + #@ xo_emit("{,hn-1000:value}", value); + #@ Should be: + #@ xo_emit("{h,hn-1000:value}", value); + #@ The hn-* modifiers (hn-decimal, hn-space, hn-1000) + #@ are only valid for fields with the {h:} modifier. + error("Field has hn-* modifier but not 'h' modifier"); + } + } + + # A value field + if (length($field[0]) == 0 || $field[0] =~ /V/) { + + #@ Value field must have a name (as content)") + #@ xo_emit("{:/%s}", "value"); + #@ Should be: + #@ xo_emit("{:tag-name/%s}", "value"); + #@ The field name is used for XML and JSON encodings. These + #@ tags names are static and must appear directly in the + #@ field descriptor. + error("value field must have a name (as content)") + unless $field[1]; + + #@ Use hyphens, not underscores, for value field name + #@ xo_emit("{:no_under_scores}", "bad"); + #@ Should be: + #@ xo_emit("{:no-under-scores}", "bad"); + #@ Use of hyphens is traditional in XML, and the XOF_UNDERSCORES + #@ flag can be used to generate underscores in JSON, if desired. + #@ But the raw field name should use hyphens. + error("use hyphens, not underscores, for value field name") + if $field[1] =~ /_/; + + #@ Value field name cannot start with digit + #@ xo_emit("{:10-gig/}"); + #@ Should be: + #@ xo_emit("{:ten-gig/}"); + #@ XML element names cannot start with a digit. + error("value field name cannot start with digit") + if $field[1] =~ /^[0-9]/; + + #@ Value field name should be lower case + #@ xo_emit("{:WHY-ARE-YOU-SHOUTING}", "NO REASON"); + #@ Should be: + #@ xo_emit("{:why-are-you-shouting}", "no reason"); + #@ Lower case is more civilized. Even TLAs should be lower case + #@ to avoid scenarios where the differences between "XPath" and + #@ "Xpath" drive your users crazy. Lower case rules the seas. + error("value field name should be lower case") + if $field[1] =~ /[A-Z]/; + + #@ Value field name should be longer than two characters + #@ xo_emit("{:x}", "mumble"); + #@ Should be: + #@ xo_emit("{:something-meaningful}", "mumble"); + #@ Field names should be descriptive, and it's hard to + #@ be descriptive in less than two characters. Consider + #@ your users and try to make something more useful. + #@ Note that this error often occurs when the field type + #@ is placed after the colon ("{:T/%20s}"), instead of before + #@ it ("{T:/20s}"). + error("value field name should be longer than two characters") + if $field[1] =~ /[A-Z]/; + + #@ Value field name contains invalid character + #@ xo_emit("{:cost-in-$$/%u}", 15); + #@ Should be: + #@ xo_emit("{:cost-in-dollars/%u}", 15); + #@ An invalid character is often a sign of a typo, like "{:]}" + #@ instead of "{]:}". Field names are restricted to lower-case + #@ characters, digits, and hyphens. + error("value field name contains invalid character (" . $field[1] . ")") + unless $field[1] =~ /^[0-9a-z-]*$/; + } + + # A decoration field + if ($field[0] =~ /D/) { + + #@decoration field contains invalid character + #@ xo_emit("{D:not good}"); + #@ Should be: + #@ xo_emit("{D:((}{:good}{D:))}", "yes"); + #@ This is minor, but fields should use proper roles. Decoration + #@ fields are meant to hold punctuation and other characters used + #@ to decorate the content, typically to make it more readable + #@ to human readers. + warn("decoration field contains invalid character") + unless $field[1] =~ m:^[~!\@\#\$%^&\*\(\);\:\[\]\{\} ]+$:; + } + + if ($field[0] =~ /[\[\]]/) { + #@ Anchor content should be decimal width + #@ xo_emit("{[:mumble}"); + #@ Should be: + #@ xo_emit("{[:32}"); + #@ Anchors need an integer value to specify the width of + #@ the set of anchored fields. The value can be positive + #@ (for left padding/right justification) or negative (for + #@ right padding/left justification) and can appear in + #@ either the start or stop anchor field descriptor. + error("anchor content should be decimal width") + if $field[1] && $field[1] !~ /^-?\d+$/ ; + + #@ Anchor format should be "%d" + #@ xo_emit("{[:/%s}"); + #@ Should be: + #@ xo_emit("{[:/%d}"); + #@ Anchors only grok integer values, and if the value is not static, + #@ if must be in an 'int' argument, represented by the "%d" format. + #@ Anything else is an error. + error("anchor format should be \"%d\"") + if $field[2] && $field[2] ne "%d"; + + #@ Anchor cannot have both format and encoding format") + #@ xo_emit("{[:32/%d}"); + #@ Should be: + #@ xo_emit("{[:32}"); + #@ Anchors can have a static value or argument for the width, + #@ but cannot have both. + error("anchor cannot have both format and encoding format") + if $field[1] && $field[2]; + } +} + +sub count_args { + my($format) = @_; + + return -1 unless $format; + + my $in; + my($text, $ff, $fc, $rest); + for ($in = $format; $in; $in = $rest) { + ($text, $ff, $fc, $rest) = + ($in =~ /^([^%]*)(%[^%diouxXDOUeEfFgGaAcCsSp]*)([diouxXDOUeEfFgGaAcCsSp])(.*)$/); + unless ($ff) { + # Might be a "%%" + ($text, $ff, $rest) = ($in =~ /^([^%]*)(%%)(.*)$/); + if ($ff) { + check_text($text); + } else { + # Not sure what's going on here, but something's wrong... + error("invalid field format") if $in =~ /%/; + } + next; + } + + check_text($text); + check_field_format($ff, $fc); + } + + return 0; +} + +sub check_field_format { + my($ff, $fc) = @_; + + print "check_field_format: [$ff] [$fc]\n" if $opt_debug; + + my(@chunks) = split(/\./, $ff); + + #@ Max width only valid for strings + #@ xo_emit("{:tag/%2.4.6d}", 55); + #@ Should be: + #@ xo_emit("{:tag/%2.6d}", 55); + #@ libxo allows a true 'max width' in addition to the traditional + #@ printf-style 'max number of bytes to use for input'. But this + #@ is supported only for string values, since it makes no sense + #@ for non-strings. This error may occur from a typo, + #@ like "{:tag/%6..6d}" where only one period should be used. + error("max width only valid for strings") + if $#chunks >= 2 && $fc !~ /[sS]/; +} + +sub error { + return if $opt_vocabulary; + print STDERR $curfile . ": " .$curln . ": error: " . join(" ", @_) . "\n"; + print STDERR $replay . "\n" if $opt_print; + $errors += 1; +} + +sub warn { + return if $opt_vocabulary; + print STDERR $curfile . ": " .$curln . ": warning: " . join(" ", @_) . "\n"; + print STDERR $replay . "\n" if $opt_print; + $warnings += 1; +} + +sub info { + return if $opt_vocabulary; + print STDERR $curfile . ": " .$curln . ": info: " . join(" ", @_) . "\n"; + print STDERR $replay . "\n" if $opt_print; + $info += 1; +} + +main: { + main(); +} diff --git a/contrib/libxo/xopo/Makefile.am b/contrib/libxo/xopo/Makefile.am new file mode 100644 index 000000000000..192d30800cec --- /dev/null +++ b/contrib/libxo/xopo/Makefile.am @@ -0,0 +1,43 @@ +# +# Copyright 2014, Juniper Networks, Inc. +# All rights reserved. +# This SOFTWARE is licensed under the LICENSE provided in the +# ../Copyright file. By downloading, installing, copying, or otherwise +# using the SOFTWARE, you agree to be bound by the terms of that +# LICENSE. + +if LIBXO_WARNINGS_HIGH +LIBXO_WARNINGS = HIGH +endif +include ${top_srcdir}/warnings.mk + +AM_CFLAGS = \ + -DLIBXO_XMLSOFT_NEED_PRIVATE \ + -I${top_builddir} \ + -I${top_srcdir} \ + -I${top_srcdir}/libxo \ + ${WARNINGS} + +LIBS = \ + ${LIBXO_LIBS} + +bin_PROGRAMS = xopo + +xopo_SOURCES = xopo.c +#xo_LDADD = ../libxo/libxo.la +#xo_LDFLAGS = -static + +LDADD = \ + ${top_builddir}/libxo/libxo.la + +if HAVE_HUMANIZE_NUMBER +LDADD += -lutil +endif + +man_MANS = xopo.1 + +EXTRA_DIST = xopo.1 + +install-data-hook: + for file in ${man_MANS}; do \ + cat ../libxo/add.man >> ${DESTDIR}${man1dir}/$$file ; done diff --git a/contrib/libxo/xopo/xopo.1 b/contrib/libxo/xopo/xopo.1 new file mode 100644 index 000000000000..1634202476a2 --- /dev/null +++ b/contrib/libxo/xopo/xopo.1 @@ -0,0 +1,87 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2015 +.\" +.Dd July 9, 2015 +.Dt XOPO 1 +.Os +.Sh NAME +.Nm xopo +.Nd turn libxo format strings into simplified form +.Sh SYNOPSIS +.Nm +.Op Fl options +.Sh DESCRIPTION +The +.Nm +utility simplifies libxo format strings into the form used for +.Xr gettext +lookups by the +.Nm libxo +library. +Using +.Nm , +users can turn +.Em .pot +files generated by +.Xr xgettext +into data useful for libxo-enabled applications. +.Pp +Since +.Xr gettext +uses the string as the key into the message catalog, +.Nm libxo +uses a simplified version of the format string that removes +unimportant field formatting and modifiers, stopping minor formatting +changes from impacting the expensive translation process. +A developer +change such as changing "/%06d" to "/%08d" should not force hand +inspection of all .po files. +.Pp +.Nm +inspects the input file, looking for lines that begin with "msgid" +which carry format strings as the remainder of the input line. +These strings are passed to +.Nm libxo +for simplification and the resulting strings are replaced into the +output stream, allowing +.Nm +to operated as a filter. +.Pp +.Bl -tag -width indent +.It Ic -f Ar pofile | Ic --po Ar pofile +Use the given po file for input. +.It Ic --help +Display this help text +.It Ic -o Ar file | Ic --output Ar file +Write output content to the given file +.It Ic -s Ar text | Ic --simplify Ar text +Generate the simplified version of a single text string. +.It Ic -W | Ic --warn +Generate warnings while parsing the format strings +.It Ic --version +Display version information +.El +.Pp +.Sh EXAMPLE +.Bd -literal + % xopo -f foo.pot -o foo.pot.new +.Ed +.Sh SEE ALSO +.Xr libxo 3 , +.Xr xo_format 5 +.Sh HISTORY +The +.Nm libxo +library first appeared in +.Fx 11.0 . +.Sh AUTHORS +.Nm libxo +was written by +.An Phil Shafer Aq Mt phil@freebsd.org . + diff --git a/contrib/libxo/xopo/xopo.c b/contrib/libxo/xopo/xopo.c new file mode 100644 index 000000000000..d802e9d863a8 --- /dev/null +++ b/contrib/libxo/xopo/xopo.c @@ -0,0 +1,289 @@ +/* + * Copyright (c) 2014, 2015, Juniper Networks, Inc. + * All rights reserved. + * This SOFTWARE is licensed under the LICENSE provided in the + * ../Copyright file. By downloading, installing, copying, or otherwise + * using the SOFTWARE, you agree to be bound by the terms of that + * LICENSE. + * Phil Shafer, July 2015 + */ + +#include <stdio.h> +#include <stdlib.h> +#include <stdarg.h> +#include <unistd.h> +#include <string.h> +#include <ctype.h> +#include <sys/queue.h> + +#include "xo_config.h" +#include "xo.h" + +#include <getopt.h> /* Include after xo.h for testing */ + +#ifndef UNUSED +#define UNUSED __attribute__ ((__unused__)) +#endif /* UNUSED */ + +static int opt_warn; /* Enable warnings */ +static int opt_numbers; /* Number our fields */ + +typedef struct xopo_msg_s { + TAILQ_ENTRY(xopo_msg_s) xm_link; + char *xm_plural; /* If plural, points to the second part */ + char xm_data[0]; /* Start of data */ +} xopo_msg_t; + +typedef TAILQ_HEAD(xopo_msg_list_s, xopo_msg_s) xopo_msg_list_t; + +static xopo_msg_list_t field_list; + +static void +xopo_msg_cb (const char *str, unsigned len, int plural) +{ + int sz = sizeof(xopo_msg_t) + len + 1; + xopo_msg_t *xmp = malloc(sz); + if (xmp == NULL) + return; + + bzero(xmp, sz); + memcpy(xmp->xm_data, str, len); + xmp->xm_data[len] = '\0'; + + if (plural) { + char *cp = strchr(xmp->xm_data, ','); + if (cp) { + *cp++ = '\0'; + xmp->xm_plural = cp; + } + } + + xopo_msg_t *xmp2; + + TAILQ_FOREACH(xmp2, &field_list, xm_link) { + if (strcmp(xmp->xm_data, xmp2->xm_data) == 0) { + /* Houston, we have a negative on that trajectory */ + free(xmp); + return; + } + } + + TAILQ_INSERT_TAIL(&field_list, xmp, xm_link); +} + +static void +print_version (void) +{ + fprintf(stderr, "libxo version %s%s\n", + xo_version, xo_version_extra); + fprintf(stderr, "xopo version %s%s\n", + LIBXO_VERSION, LIBXO_VERSION_EXTRA); +} + +static void +print_help (void) +{ + fprintf(stderr, +"Usage: xopo [options] format [fields]\n" +" --help Display this help text\n" +" --option <opts> -or -O <opts> Give formatting options\n" +" --output <file> -or -o <file> Use file as output destination\n" +" --po <file> or -f <file> Generate new msgid's for a po file\n" +" --simplify <text> OR -s <text> Show simplified form of the format string\n" +" --version Display version information\n" +" --warn OR -W Display warnings in text on stderr\n" +); +} + +static struct opts { + int o_help; + int o_version; +} opts; + +static struct option long_opts[] = { + { "help", no_argument, &opts.o_help, 1 }, + { "number", no_argument, NULL, 'n' }, + { "option", required_argument, NULL, 'O' }, + { "output", required_argument, NULL, 'o' }, + { "po", required_argument, NULL, 'f' }, + { "simplify", no_argument, NULL, 'S' }, + { "warn", no_argument, NULL, 'W' }, + { NULL, 0, NULL, 0 } +}; + +int +main (int argc UNUSED, char **argv) +{ + char *opt_options = NULL; + char *opt_input = NULL; + char *opt_output = NULL; + char *opt_simplify = NULL; + int rc; + + argc = xo_parse_args(argc, argv); + if (argc < 0) + return 1; + + while ((rc = getopt_long(argc, argv, "f:no:O:s:W", + long_opts, NULL)) != -1) { + switch (rc) { + case 'f': + opt_input = optarg; + break; + + case 'n': + opt_numbers = 1; + break; + + case 'o': + opt_output = optarg; + break; + + case 'O': + opt_options = optarg; + break; + + case 's': + opt_simplify = optarg; + break; + + case 'W': + opt_warn = 1; + xo_set_flags(NULL, XOF_WARN); + break; + + case ':': + xo_errx(1, "missing argument"); + break; + + case 0: + if (opts.o_help) { + print_help(); + return 1; + + } else if (opts.o_version) { + print_version(); + return 0; + + } else { + print_help(); + return 1; + } + + bzero(&opts, sizeof(opts)); /* Reset all the options */ + break; + + default: + print_help(); + return 1; + } + } + + argc -= optind; + argv += optind; + + if (opt_options) { + rc = xo_set_options(NULL, opt_options); + if (rc < 0) + xo_errx(1, "invalid options: %s", opt_options); + } + + if (opt_simplify) { + char *fmt = xo_simplify_format(NULL, opt_simplify, opt_numbers, NULL); + if (fmt) { + xo_emit("{:format}\n", fmt); + free(fmt); + } + exit(0); + } + + static char msgid[] = "msgid "; + char buf[BUFSIZ], *cp, *ep; + FILE *infile; + FILE *outfile; + TAILQ_INIT(&field_list); + + if (opt_input) { + infile = fopen(opt_input, "r"); + if (infile == NULL) + xo_emit_err(1, "count not open input file: '{:filename}'", + opt_input); + } else + infile = stdin; + + if (opt_output) { + unlink(opt_output); + outfile = fopen(opt_output, "w"); + if (outfile == NULL) + xo_emit_err(1, "count not open output file: '{:filename}'", + opt_output); + } else + outfile = stdout; + + int blank = 0, line; + + for (line = 1;; line++) { + if (fgets(buf, sizeof(buf), infile) == NULL) + break; + + if (buf[0] == '#' && buf[1] == '\n') + continue; + + blank = (buf[0] == '\n' && buf[1] == '\0'); + + if (strncmp(buf, msgid, sizeof(msgid) - 1) != 0) { + fprintf(outfile, "%s", buf); + continue; + } + + for (cp = buf + sizeof(msgid); *cp; cp++) + if (!isspace((int) *cp)) + break; + + if (*cp == '"') + cp += 1; + + ep = cp + strlen(cp); + if (ep > cp) + ep -= 1; + + while (isspace((int) *ep) && ep > cp) + ep -= 1; + + if (*ep != '"') + *ep += 1; + + *ep = '\0'; + + cp = xo_simplify_format(NULL, cp, opt_numbers, xopo_msg_cb); + if (cp) { + fprintf(outfile, "msgid \"%s\"\n", cp); + free(cp); + } + } + + if (!blank) + fprintf(outfile, "\n"); + + xopo_msg_t *xmp; + TAILQ_FOREACH(xmp, &field_list, xm_link) { + if (xmp->xm_plural) { + fprintf(outfile, "msgid \"%s\"\n" + "msgid_plural \"%s\"\n" + "msgstr[0] \"\"\n" + "msgstr[1] \"\"\n\n", + xmp->xm_data, xmp->xm_plural); + } else { + fprintf(outfile, "msgid \"%s\"\nmsgstr \"\"\n\n", xmp->xm_data); + } + } + + if (infile != stdin) + fclose(infile); + if (outfile != stdout) + fclose(outfile); + + xo_finish(); + + return 0; +} |