summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRuey-Hsia Li <rli@ncsa.uiuc.edu>1998-12-21 22:54:16 (GMT)
committerRuey-Hsia Li <rli@ncsa.uiuc.edu>1998-12-21 22:54:16 (GMT)
commitbe41a8feed17662435ef603844aba2bbf721e13b (patch)
treed4fc25a92c11e5f4a0b92b1e4444d3ece0d14ef6 /doc
parent82fb21b613326522eb0a51f507fd836fb5879c9a (diff)
downloadhdf5-be41a8feed17662435ef603844aba2bbf721e13b.zip
hdf5-be41a8feed17662435ef603844aba2bbf721e13b.tar.gz
hdf5-be41a8feed17662435ef603844aba2bbf721e13b.tar.bz2
[svn-r986] Defined <data> and <string> in ddl.html.
Updated the current status of dumper.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/Tools.html16
-rw-r--r--doc/html/ddl.html103
2 files changed, 89 insertions, 30 deletions
diff --git a/doc/html/Tools.html b/doc/html/Tools.html
index b850862..192815a 100644
--- a/doc/html/Tools.html
+++ b/doc/html/Tools.html
@@ -162,15 +162,23 @@ These tools enable the user to examine HDF5 files interactively.
</ul>
<li>Data type
<ul>
- <li>scalar type
- <li>transient type
- <li>named type
- <li>unnamed type
+ <li>atomic type
+ <li>compound type
+ <li>string type
</ul>
<li>Simple data space
<li>Soft link
<li>Hard link
+ <li>Loop detection
</ul>
+ <dd>The to do list includes:
+ <ul>
+ <li>Display data correctly
+ <li>Make h5dump output consistent with DDL
+ <li>Support storage layout
+ <li>Define file boot block
+ </ul>
+
<dt><strong>See Also:</strong>
<dd>HDF5 Data Description Language syntax
(<a href="ddl.html"><cite>DDL for HDF5</cite></a>)
diff --git a/doc/html/ddl.html b/doc/html/ddl.html
index 8405c77..0c57ef2 100644
--- a/doc/html/ddl.html
+++ b/doc/html/ddl.html
@@ -103,23 +103,54 @@ This section contains a brief explanation of the symbols used in the DDL.
&lt;root_group&gt; ::= GROUP "/" { &lt;unamed_datatype&gt;* &lt;group_attribute&gt;* &lt;group_member&gt;* }
-&lt;unamed_datatype&gt ::= DATATYPE "&lt;unamed_type_name&gt;" { &lt;compound_type_def&gt;+ }
+&lt;unamed_datatype&gt ::= DATATYPE "&lt;unamed_type_name&gt;" { &lt;compound_type&gt; }
&lt;unamed_type_name&gt; ::= the assigned name for unamed type is in the form of
#oid1:oid2, where oid1 and oid2 are the object ids of the type
-&lt;compound_type_def&gt; ::= &lt;named_scalar_type&gt; | &lt;named_array_type&gt;
+&lt;compound_type&gt; ::= &lt;member_type_def&gt;+
-&lt;named_scalar_type&gt; ::= &lt;scalar_type&gt; &lt;field_name&gt; ;
+&lt;member_type_def&gt; ::= &lt;scalar_type_def&gt; | &lt;array_type_def&gt;
-&lt;scalar_type&gt; ::= H5T_STD_I8BE | H5T_STD_I8LE | ...
+&lt;scalar_type_def&gt; ::= &lt;atomic_type&gt; "&lt;field_name&gt;" ;
+
+&lt;atomic_type&gt; ::= &lt;integer&gt; | &lt;float&gt; | &lt;time&gt; | &lt;string&gt; | &lt;bitfield&gt; | &lt;opaque&gt;
+
+&lt;integer&gt; ::= H5T_STD_I8LE | H5T_STD_I16BE | H5T_STD_I16LE | H5T_STD_I32BE |
+ H5T_STD_I32LE | H5T_STD_I64BE | H5T_STD_I64LE | H5T_STD_U8BE |
+ H5T_STD_U8LE | H5T_STD_U16BE | H5T_STD_U16LE | H5T_STD_U32BE |
+ H5T_STD_U32LE | H5T_STD_U64BE | H5T_STD_U64LE | H5T_NATIVE_CHAR |
+ H5T_NATIVE_UCHAR | H5T_NATIVE_SHORT | H5T_NATIVE_USHORT |
+ H5T_NATIVE_INT | H5T_NATIVE_UINT | H5T_NATIVE_LONG | H5T_NATIVE_ULONG |
+ H5T_NATIVE_LLONG | H5T_NATIVE_ULLONG
+
+&lt;float&gt; ::= H5T_IEEE_F32BE | H5T_IEEE_F32LE | H5T_IEEE_F64BE | H5T_IEEE_F64LE |
+ H5T_NATIVE_FLOAT | H5T_NATIVE_DOUBLE | H5T_NATIVE_LDOUBLE
+
+&lt;time&gt; ::= TBD
+
+&lt;string&gt; ::= { STRSIZE &lt;strsize&gt; ;
+ STRPAD &lt;strpad&gt; ;
+ CSET &lt;cset&gt; ;
+ CTYPE &lt;ctype&gt; ; }
+
+&lt;strsize&gt; ::= an integer
+
+&lt;strpad&gt; ::= H5T_STR_NULLTERM | H5T_STR_NULLPAD | H5T_STR_SPACEPAD
+
+&lt;cset&gt; ::= H5T_CSET_ASCII
+
+&lt;ctype&gt; ::= H5T_C_S1 | H5T_FORTRAN_S1
+
+&lt;bitfield&gt; ::= TBD
+
+&lt;opaque&gt; ::= TBD
&lt;field_name&gt; ::= &lt;identifier&gt;
-&lt;named_array_type&gt; ::= &lt;scalar_type&gt; &lt;field_name&gt; &lt;dim_sizes&gt; ;
+&lt;array_type_def&gt; ::= &lt;atomic_type&gt; "&lt;field_name&gt;" &lt;dim_sizes&gt; ;
-&lt;dim_sizes&gt; ::= dimension sizes in the form of [dimsize1][dimzise2]...,
- where dimsize1, dimsize2 are integers
+&lt;dim_sizes&gt; ::= [dimsize1][dimzise2]..., where dimsize1, dimsize2 are integers
&lt;group_attribute&gt; ::= &lt;attribute&gt;
@@ -128,48 +159,68 @@ This section contains a brief explanation of the symbols used in the DDL.
&lt;data&gt;<FONT SIZE=1.7>opt</FONT> }
// &lt;datatype&gt; and &lt;dataspace&gt; must appear before &lt;data&gt;.
-&lt;attr_name&gt; ::= &lt;identifier&gt;
+&lt;attr_name&gt; ::= &lt;identifier&gt
+
+&lt;datatype&gt; ::= DATATYPE { &lt;atomic_type&gt; } |
+ DATATYPE { &lt;compound_type&gt; }
+ DATATYPE { &lt;named_type&gt; }
-&lt;datatype&gt; ::= DATATYPE { &lt;named_type&gt; } |
- DATATYPE { "&lt;scalar_type&gt;" } |
- DATATYPE { &lt;compound_type_def&gt;+ }
+&lt;named_type&gt; ::= "&lt;path_name&gt;"
-&lt;named_type&gt; ::= &lt;hardlink&gt;
+&lt;path_name&gt; ::= &lt;identifier&gt
-&lt;hardlink&gt; ::= HARDLINK { "&lt;abs_name&gt;" }
+&lt;dataspace&gt; ::= DATASPACE { SCALAR } |
+ DATASPACE { SIMPLE &lt;current_dims&gt; / &lt;max_dims&gt; } |
+ DATASPACE { COMPLEX &lt;ds_definition&gt;+ }
+ DATASPACE { "&lt;dataspace_name&gt;" } |
-&lt;abs_name&gt; ::= object absolute name
+&lt;current_dims&gt; ::= (<i>i<FONT SIZE=1.0>1</i></FONT>, <i>i<FONT SIZE=1.0>2</i></FONT>, ... ), where <i>i<FONT SIZE=1.0>k</i></FONT> is an integer, <i>k</i> = 1,2,...
-&lt;dataspace&gt; ::= DATASPACE { "&lt;dataspace_name&gt;" } |
- DATASPACE { ARRAY &lt;current_dims&gt; &lt;max_dims&gt; } |
- DATASPACE { OTHER &lt;ds_definition&gt;+ }
+&lt;max_dims&gt; ::= (<i>i<FONT SIZE=1.0>1</i></FONT>, <i>i<FONT SIZE=1.0>2</i></FONT>, ... ) where <i>i<FONT SIZE=1.0>k</i></FONT> is an integer or H5S_UNLIMITED
+
+&lt;ds_definition&gt; ::= TBD
&lt;dataspace_name&gt; ::= &lt;identifier&gt;
-&lt;current_dims&gt; ::= a list of integers in the form of (<i>i<FONT SIZE=1.0>1</i></FONT>, <i>i<FONT SIZE=1.0>2</i></FONT>, ... ),
- where <i>i<FONT SIZE=1.0>k</i></FONT> is an integer, <i>k</i> = 1,2,...
+&lt;data&gt; ::= DATA { &lt;scalar_space_data&gt; | &lt;simple_space_data&gt; | &lt;complex_space_data&gt; }
+
+&lt;scalar_space_data&gt; ::= &lt;atomic_scalar_data&gt; | &lt;compound_scalar_data&gt;
-&lt;max_dims&gt; ::= (<i>i<FONT SIZE=1.0>1</i></FONT>, <i>i<FONT SIZE=1.0>2</i></FONT>, ... ) where <i>i<FONT SIZE=1.0>k</i></FONT> is an integer or H5S_UNLIMITED
+&lt;atomic_scalar_data&gt; :: = the value of data
+// A string is enclosed in double quotes.
-&lt;ds_definition&gt; ::= TBD
+&lt;compound_scalar_data&gt; ::= { [ &lt;member_data&gt; ], [ &lt;member_data&gt; ], ... }
+
+&lt;member_data&gt; ::= &lt;atomic_scalar_data&gt; | &lt;atomic_simple_data&gt;
-&lt;data&gt; ::= data {TBD}
+&lt;atomic_simple_data&gt; :: = &lt;atomic_element&gt;, &lt;atomic_element&gt;, ...
+
+&lt;atomic_element&gt; ::= &lt;atomic_scalar_data&gt;
+
+&lt;simple_space_data&gt; :: = &lt;atomic_simple_data&gt; | &lt;compound_simple_data&gt;
+
+&lt;compound_simple_data&gt; ::= &lt;compoud_element&gt;, &lt;compound_element&gt;, ...
+
+&lt;compound_element&gt; ::= &lt;compound_scalar_data&gt;
+
+&lt;complex_space_data&gt; ::= TBD
&lt;group_member&gt; ::= &lt;named_datatype&gt; | &lt;named_dataspace&gt; | &lt;group&gt; | &lt;dataset&gt; |
&lt;softlink&gt;
-&lt;named_datatype&gt; ::= DATATYPE "&lt;type_name&gt;" { &lt;compound_type_def&gt;+ }
+&lt;named_datatype&gt; ::= DATATYPE "&lt;type_name&gt;" { &lt;compound_type&gt; }
-&lt;type_name&gt; ::= "&lt;identifier&gt;"
+&lt;type_name&gt; ::= &lt;identifier&gt;
-&lt;named_dataspace&gt; ::= DATASPACE "&lt;dataspace_name&gt;" { ARRAY &lt;current_dims&gt; &lt;max_dims&gt; } |
- DATASPACE "&lt;dataspace_name&gt;" { OTHER &lt;ds_definition&gt;+ }
+&lt;named_dataspace&gt; ::= TBD
&lt;group&gt; ::= GROUP "&lt;group_name&gt;" { &lt;hardlink&gt; } |
GROUP "&lt;group_name&gt;" { &lt;group_attribute&gt;* &lt;group_member&gt;* }
&lt;group_name&gt; ::= &lt;identifier&gt;
+&lt;hardlink&gt; ::= HARDLINK "&lt;path_name&gt;"
+
&lt;dataset&gt; ::= DATASET "&lt;dataset_name&gt;" { &lt;hardlink&gt; } |
DATASET "&lt;dataset_name&gt;" { &lt;datatype&gt;
&lt;dataspace&gt;