.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "JavaScript 3pm" .TH JavaScript 3pm "2008-08-14" "perl v5.10.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Data::JavaScript \- Dump perl data structures into JavaScript code .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Data::JavaScript; # Use defaults \& \& @code = jsdump(\*(Aqmy_array\*(Aq, $array_ref); # Return array for formatting \& $code = jsdump(\*(Aqmy_object\*(Aq, $hash_ref); # Return convenient string \& $html = hjsdump(\*(Aqmy_stuff\*(Aq, $reference); # Convenience wrapper .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is mainly intended for \s-1CGI\s0 programming, when a perl script generates a page with client side JavaScript code that needs access to structures created on the server. .PP It works by creating one line of JavaScript code per datum. Therefore, structures cannot be created anonymously and need to be assigned to variables. However, this format enables dumping large structures. .PP The module can output code for different versions of JavaScript. It currently supports 1.1, 1.3 and you specify the version on the \&\f(CW\*(C`use\*(C'\fR line like so: .PP .Vb 2 \& use Data::JavaScript {JS=>1.3}; # The new default \& use Data::JavaScript {JS=>1.1}; # Old (pre module v1.10) format .Ve .PP JavaScript 1.3 contains support for \s-1UTF\-8\s0 and a native \f(CW\*(C`undefined\*(C'\fR datatype. Earlier versions support neither, and will default to an empty string \f(CW\*(Aq\*(Aq\fR for undefined values. You may define your own default\*(--for either version\*(--at compile time by supplying the default value on the \f(CW\*(C`use\*(C'\fR line: .PP .Vb 1 \& use Data::JavaScript {JS=>1.1, UNDEF=>\*(Aqnull\*(Aq}; .Ve .PP Other useful values might be \f(CW0\fR, \f(CW\*(C`null\*(C'\fR, or \f(CW\*(C`NaN\*(C'\fR. .SH "EXPORT" .IX Header "EXPORT" In addition, althought the module no longer uses Exporter, it heeds its import conventions; \f(CW\*(C`qw(:all\*(C'\fR), \f(CW\*(C`()\*(C'\fR, etc. .IP "jsdump('name', \e$reference, [$undef]);" 4 .IX Item "jsdump('name', $reference, [$undef]);" The first argument is required, the name of JavaScript object to create. .Sp The second argument is required, a hashref or arrayref. Structures can be nested, circular referrencing is supported (experimentally). .Sp The third argument is optional, a scalar whose value is to be used en lieu of undefined values when dumping a structure. .Sp When called in list context, the function returns a list of lines. In scalar context, it returns a string. .IP "hjsdump('name', \e$reference, [$undef]);" 4 .IX Item "hjsdump('name', $reference, [$undef]);" hjsdump is identical to jsdump except that it wraps the content in script tags. .SH "EXPORTABLE" .IX Header "EXPORTABLE" .IP "_\|_quotemeta($str)" 4 .IX Item "__quotemeta($str)" This function escapes non-printable and Unicode characters (where possible) to promote playing nice with others. .SH "CAVEATS" .IX Header "CAVEATS" Previously, the module eval'd any data it received that looked like a number; read: real, hexadecimal, octal, or engineering notations. It now passes all non-decimal values through as strings. You will need to \f(CW\*(C`eval\*(C'\fR on the client or server side if you wish to use other notations as numbers. This is meant to protect people who store \s-1ZIP\s0 codes with leading 0's. .PP Unicode support requires perl 5.8 or later. Older perls will gleefully escape the non-printable portions of any \s-1UTF\-8\s0 they are fed, likely munging it in the process as far as JavaScript is concerned. If this turns out to be a problem and there is sufficient interest it may be possible to hack-in \s-1UTF\-8\s0 escaping for older perls. .SH "LICENSE" .IX Header "LICENSE" .IP "\(bu" 4 Thou shalt not claim ownership of unmodified materials. .IP "\(bu" 4 Thou shalt not claim whole ownership of modified materials. .IP "\(bu" 4 Thou shalt grant the indemnity of the provider of materials. .IP "\(bu" 4 Thou shalt use and dispense freely without other restrictions. .PP Or if you truly insist, you may use and distribute this under ther terms of Perl itself (\s-1GPL\s0 and/or Artistic License). .SH "SEE ALSO" .IX Header "SEE ALSO" Data::JavaScript::LiteObject, Data::JavaScript::Anon, \s-1CGI::AJAX\s0 .SH "AUTHOR" .IX Header "AUTHOR" Maintained by Jerrad Pierce .PP Created by Ariel Brosh . Inspired by \s-1WDDX\s0.pm JavaScript support.