From 7b24efd6f333620ed2559d70b32da8f6f9957385 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Sat, 21 Sep 2013 23:25:48 -0700 Subject: rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules. --- Makefile.in | 6 - RELEASES.txt | 3 +- mk/clean.mk | 6 - mk/dist.mk | 1 - mk/docs.mk | 31 +- mk/install.mk | 5 - mk/tests.mk | 10 +- mk/tools.mk | 45 - src/librust/rust.rs | 6 +- src/librustdoc/astsrv.rs | 186 ---- src/librustdoc/attr_parser.rs | 149 ---- src/librustdoc/attr_pass.rs | 326 ------- src/librustdoc/clean.rs | 1094 +++++++++++++++++++++++ src/librustdoc/config.rs | 373 -------- src/librustdoc/core.rs | 78 ++ src/librustdoc/demo.rs | 199 ----- src/librustdoc/desc_to_brief_pass.rs | 288 ------ src/librustdoc/doc.rs | 393 --------- src/librustdoc/doctree.rs | 168 ++++ src/librustdoc/escape_pass.rs | 29 - src/librustdoc/extract.rs | 414 --------- src/librustdoc/fold.rs | 481 ++-------- src/librustdoc/html/format.rs | 364 ++++++++ src/librustdoc/html/layout.rs | 130 +++ src/librustdoc/html/markdown.rs | 54 ++ src/librustdoc/html/render.rs | 1108 ++++++++++++++++++++++++ src/librustdoc/html/static/jquery-2.0.3.min.js | 6 + src/librustdoc/html/static/main.css | 270 ++++++ src/librustdoc/html/static/main.js | 420 +++++++++ src/librustdoc/html/static/normalize.css | 396 +++++++++ src/librustdoc/markdown_index_pass.rs | 284 ------ src/librustdoc/markdown_pass.rs | 941 -------------------- src/librustdoc/markdown_writer.rs | 287 ------ src/librustdoc/page_pass.rs | 185 ---- src/librustdoc/parse.rs | 41 - src/librustdoc/pass.rs | 96 -- src/librustdoc/passes.rs | 231 +++++ src/librustdoc/path_pass.rs | 115 --- src/librustdoc/plugins.rs | 90 ++ src/librustdoc/prune_hidden_pass.rs | 83 -- src/librustdoc/prune_private_pass.rs | 255 ------ src/librustdoc/rustdoc.rs | 289 +++--- src/librustdoc/sectionalize_pass.rs | 257 ------ src/librustdoc/sort_item_name_pass.rs | 38 - src/librustdoc/sort_item_type_pass.rs | 67 -- src/librustdoc/sort_pass.rs | 103 --- src/librustdoc/text_pass.rs | 313 ------- src/librustdoc/trim_pass.rs | 52 -- src/librustdoc/tystr_pass.rs | 456 ---------- src/librustdoc/unindent_pass.rs | 134 --- src/librustdoc/visit_ast.rs | 183 ++++ src/rustdoc_ng/.gitignore | 2 - src/rustdoc_ng/clean.rs | 1094 ----------------------- src/rustdoc_ng/core.rs | 78 -- src/rustdoc_ng/doctree.rs | 168 ---- src/rustdoc_ng/fold.rs | 99 --- src/rustdoc_ng/html/format.rs | 364 -------- src/rustdoc_ng/html/layout.rs | 130 --- src/rustdoc_ng/html/markdown.rs | 54 -- src/rustdoc_ng/html/render.rs | 1108 ------------------------ src/rustdoc_ng/html/static/jquery-2.0.3.min.js | 6 - src/rustdoc_ng/html/static/main.css | 270 ------ src/rustdoc_ng/html/static/main.js | 420 --------- src/rustdoc_ng/html/static/normalize.css | 396 --------- src/rustdoc_ng/passes.rs | 231 ----- src/rustdoc_ng/plugins.rs | 90 -- src/rustdoc_ng/rustdoc_ng.rs | 211 ----- src/rustdoc_ng/visit_ast.rs | 183 ---- 68 files changed, 4873 insertions(+), 11570 deletions(-) delete mode 100644 src/librustdoc/astsrv.rs delete mode 100644 src/librustdoc/attr_parser.rs delete mode 100644 src/librustdoc/attr_pass.rs create mode 100644 src/librustdoc/clean.rs delete mode 100644 src/librustdoc/config.rs create mode 100644 src/librustdoc/core.rs delete mode 100644 src/librustdoc/demo.rs delete mode 100644 src/librustdoc/desc_to_brief_pass.rs delete mode 100644 src/librustdoc/doc.rs create mode 100644 src/librustdoc/doctree.rs delete mode 100644 src/librustdoc/escape_pass.rs delete mode 100644 src/librustdoc/extract.rs create mode 100644 src/librustdoc/html/format.rs create mode 100644 src/librustdoc/html/layout.rs create mode 100644 src/librustdoc/html/markdown.rs create mode 100644 src/librustdoc/html/render.rs create mode 100644 src/librustdoc/html/static/jquery-2.0.3.min.js create mode 100644 src/librustdoc/html/static/main.css create mode 100644 src/librustdoc/html/static/main.js create mode 100644 src/librustdoc/html/static/normalize.css delete mode 100644 src/librustdoc/markdown_index_pass.rs delete mode 100644 src/librustdoc/markdown_pass.rs delete mode 100644 src/librustdoc/markdown_writer.rs delete mode 100644 src/librustdoc/page_pass.rs delete mode 100644 src/librustdoc/parse.rs delete mode 100644 src/librustdoc/pass.rs create mode 100644 src/librustdoc/passes.rs delete mode 100644 src/librustdoc/path_pass.rs create mode 100644 src/librustdoc/plugins.rs delete mode 100644 src/librustdoc/prune_hidden_pass.rs delete mode 100644 src/librustdoc/prune_private_pass.rs delete mode 100644 src/librustdoc/sectionalize_pass.rs delete mode 100644 src/librustdoc/sort_item_name_pass.rs delete mode 100644 src/librustdoc/sort_item_type_pass.rs delete mode 100644 src/librustdoc/sort_pass.rs delete mode 100644 src/librustdoc/text_pass.rs delete mode 100644 src/librustdoc/trim_pass.rs delete mode 100644 src/librustdoc/tystr_pass.rs delete mode 100644 src/librustdoc/unindent_pass.rs create mode 100644 src/librustdoc/visit_ast.rs delete mode 100644 src/rustdoc_ng/.gitignore delete mode 100644 src/rustdoc_ng/clean.rs delete mode 100644 src/rustdoc_ng/core.rs delete mode 100644 src/rustdoc_ng/doctree.rs delete mode 100644 src/rustdoc_ng/fold.rs delete mode 100644 src/rustdoc_ng/html/format.rs delete mode 100644 src/rustdoc_ng/html/layout.rs delete mode 100644 src/rustdoc_ng/html/markdown.rs delete mode 100644 src/rustdoc_ng/html/render.rs delete mode 100644 src/rustdoc_ng/html/static/jquery-2.0.3.min.js delete mode 100644 src/rustdoc_ng/html/static/main.css delete mode 100644 src/rustdoc_ng/html/static/main.js delete mode 100644 src/rustdoc_ng/html/static/normalize.css delete mode 100644 src/rustdoc_ng/passes.rs delete mode 100644 src/rustdoc_ng/plugins.rs delete mode 100644 src/rustdoc_ng/rustdoc_ng.rs delete mode 100644 src/rustdoc_ng/visit_ast.rs diff --git a/Makefile.in b/Makefile.in index 3c7542e19c7..eca5c3453e6 100644 --- a/Makefile.in +++ b/Makefile.in @@ -214,7 +214,6 @@ CFG_LIBRUSTC_$(1) :=$(call CFG_LIB_NAME_$(1),rustc) CFG_LIBSYNTAX_$(1) :=$(call CFG_LIB_NAME_$(1),syntax) CFG_LIBRUSTPKG_$(1) :=$(call CFG_LIB_NAME_$(1),rustpkg) CFG_LIBRUSTDOC_$(1) :=$(call CFG_LIB_NAME_$(1),rustdoc) -CFG_LIBRUSTDOCNG_$(1) :=$(call CFG_LIB_NAME_$(1),rustdoc_ng) CFG_LIBRUSTI_$(1) :=$(call CFG_LIB_NAME_$(1),rusti) CFG_LIBRUST_$(1) :=$(call CFG_LIB_NAME_$(1),rust) @@ -224,7 +223,6 @@ LIBRUSTC_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),rustc) LIBSYNTAX_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),syntax) LIBRUSTPKG_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),rustpkg) LIBRUSTDOC_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),rustdoc) -LIBRUSTDOCNG_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),rustdoc_ng) LIBRUSTI_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),rusti) LIBRUST_GLOB_$(1) :=$(call CFG_LIB_GLOB_$(1),rust) EXTRALIB_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),extra) @@ -233,7 +231,6 @@ LIBRUSTC_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),rustc) LIBSYNTAX_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),syntax) LIBRUSTPKG_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),rustpkg) LIBRUSTDOC_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),rustdoc) -LIBRUSTDOCNG_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),rustdoc_ng) LIBRUSTI_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),rusti) LIBRUST_DSYM_GLOB_$(1) :=$(call CFG_LIB_DSYM_GLOB_$(1),rust) @@ -442,12 +439,10 @@ CSREQ$(1)_T_$(2)_H_$(3) = \ $$(TSREQ$(1)_T_$(2)_H_$(3)) \ $$(HBIN$(1)_H_$(3))/rustpkg$$(X_$(3)) \ $$(HBIN$(1)_H_$(3))/rustdoc$$(X_$(3)) \ - $$(HBIN$(1)_H_$(3))/rustdoc_ng$$(X_$(3)) \ $$(HBIN$(1)_H_$(3))/rusti$$(X_$(3)) \ $$(HBIN$(1)_H_$(3))/rust$$(X_$(3)) \ $$(HLIB$(1)_H_$(3))/$(CFG_LIBRUSTPKG_$(3)) \ $$(HLIB$(1)_H_$(3))/$(CFG_LIBRUSTDOC_$(3)) \ - $$(HLIB$(1)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(3)) \ $$(HLIB$(1)_H_$(3))/$(CFG_LIBRUSTI_$(3)) \ $$(HLIB$(1)_H_$(3))/$(CFG_LIBRUST_$(3)) \ $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_STDLIB_$(2)) \ @@ -456,7 +451,6 @@ CSREQ$(1)_T_$(2)_H_$(3) = \ $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTC_$(2)) \ $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTPKG_$(2)) \ $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTDOC_$(2)) \ - $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(2)) \ $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTI_$(2)) \ $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUST_$(2)) diff --git a/RELEASES.txt b/RELEASES.txt index 71243df3f6c..63080fe6528 100644 --- a/RELEASES.txt +++ b/RELEASES.txt @@ -143,7 +143,8 @@ Version 0.8 (October 2013) * The runtime uses jemalloc for allocations. * Segmented stacks are temporarily disabled as part of the transition to the new runtime. Stack overflows are possible! - * A new documentation backend, rustdoc_ng, is available for use + * A new documentation backend, rustdoc_ng, is available for use. It is + still invoked through the normal `rustdoc` command. Version 0.7 (July 2013) ----------------------- diff --git a/mk/clean.mk b/mk/clean.mk index 30ec6b15bfe..cb8861f6597 100644 --- a/mk/clean.mk +++ b/mk/clean.mk @@ -68,12 +68,10 @@ clean$(1)_H_$(2): $(Q)rm -f $$(HBIN$(1)_H_$(2))/rustpkg$(X_$(2)) $(Q)rm -f $$(HBIN$(1)_H_$(2))/serializer$(X_$(2)) $(Q)rm -f $$(HBIN$(1)_H_$(2))/rustdoc$(X_$(2)) - $(Q)rm -f $$(HBIN$(1)_H_$(2))/rustdoc_ng$(X_$(2)) $(Q)rm -f $$(HBIN$(1)_H_$(2))/rusti$(X_$(2)) $(Q)rm -f $$(HBIN$(1)_H_$(2))/rust$(X_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_LIBRUSTPKG_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_LIBRUSTDOC_$(2)) - $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_LIBRUSTDOCNG_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_RUNTIME_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_STDLIB_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_EXTRALIB_$(2)) @@ -87,7 +85,6 @@ clean$(1)_H_$(2): $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(LIBSYNTAX_GLOB_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(LIBRUSTPKG_GLOB_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(LIBRUSTDOC_GLOB_$(2)) - $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(LIBRUSTDOCNG_GLOB_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(LIBRUSTI_GLOB_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(LIBRUST_GLOB_$(2)) $(Q)rm -f $$(HLIB$(1)_H_$(2))/$(CFG_RUSTLLVM_$(2)) @@ -106,12 +103,10 @@ clean$(1)_T_$(2)_H_$(3): $(Q)rm -f $$(TBIN$(1)_T_$(2)_H_$(3))/rustpkg$(X_$(2)) $(Q)rm -f $$(TBIN$(1)_T_$(2)_H_$(3))/serializer$(X_$(2)) $(Q)rm -f $$(TBIN$(1)_T_$(2)_H_$(3))/rustdoc$(X_$(2)) - $(Q)rm -f $$(TBIN$(1)_T_$(2)_H_$(3))/rustdoc_ng$(X_$(2)) $(Q)rm -f $$(TBIN$(1)_T_$(2)_H_$(3))/rusti$(X_$(2)) $(Q)rm -f $$(TBIN$(1)_T_$(2)_H_$(3))/rust$(X_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTPKG_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTDOC_$(2)) - $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_RUNTIME_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_STDLIB_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_EXTRALIB_$(2)) @@ -125,7 +120,6 @@ clean$(1)_T_$(2)_H_$(3): $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(LIBSYNTAX_GLOB_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(LIBRUSTPKG_GLOB_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(LIBRUSTDOC_GLOB_$(2)) - $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(LIBRUSTDOCNG_GLOB_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(LIBRUSTI_GLOB_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(LIBRUST_GLOB_$(2)) $(Q)rm -f $$(TLIB$(1)_T_$(2)_H_$(3))/$(CFG_RUSTLLVM_$(2)) diff --git a/mk/dist.mk b/mk/dist.mk index 34230e6a5aa..4a980edf767 100644 --- a/mk/dist.mk +++ b/mk/dist.mk @@ -39,7 +39,6 @@ PKG_FILES := \ libsyntax \ rt \ librustdoc \ - rustdoc_ng \ rustllvm \ snapshots.txt \ test) \ diff --git a/mk/docs.mk b/mk/docs.mk index d7b5d6855ad..b89bf3483fc 100644 --- a/mk/docs.mk +++ b/mk/docs.mk @@ -213,40 +213,21 @@ else # The rustdoc executable RUSTDOC = $(HBIN2_H_$(CFG_BUILD_TRIPLE))/rustdoc$(X_$(CFG_BUILD_TRIPLE)) -RUSTDOC_NG = $(HBIN2_H_$(CFG_BUILD_TRIPLE))/rustdoc_ng$(X_$(CFG_BUILD_TRIPLE)) # The library documenting macro -# $(1) - The output directory +# $(1) - The crate name (std/extra) # $(2) - The crate file -# $(3) - The crate soruce files +# $(3) - The relevant host build triple (to depend on libstd) define libdoc -doc/$(1)/index.html: $(2) $(3) $$(RUSTDOC) doc/$(1)/rust.css +doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3)) @$$(call E, rustdoc: $$@) - $(Q)$(RUSTDOC) $(2) --output-dir=doc/$(1) - -doc/$(1)/rust.css: rust.css - @$$(call E, cp: $$@) - $(Q)cp $$< $$@ + $(Q)$(RUSTDOC) html $(2) DOCS += doc/$(1)/index.html endef -# The "next generation" library documenting macro -# $(1) - The crate name (std/extra) -# $(2) - The crate file -# $(3) - The relevant host build triple (to depend on libstd) -define libdocng -doc/ng/$(1)/index.html: $$(RUSTDOC_NG) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3)) - @$$(call E, rustdoc_ng: $$@) - $(Q)$(RUSTDOC_NG) html $(2) -o doc/ng - -DOCS += doc/ng/$(1)/index.html -endef - -$(eval $(call libdoc,std,$(STDLIB_CRATE),$(STDLIB_INPUTS))) -$(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(EXTRALIB_INPUTS))) -$(eval $(call libdocng,std,$(STDLIB_CRATE),$(CFG_BUILD_TRIPLE))) -$(eval $(call libdocng,extra,$(EXTRALIB_CRATE),$(CFG_BUILD_TRIPLE))) +$(eval $(call libdoc,std,$(STDLIB_CRATE),$(CFG_BUILD_TRIPLE))) +$(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD_TRIPLE))) endif diff --git a/mk/install.mk b/mk/install.mk index 3989e4f8119..4b50c5aa796 100644 --- a/mk/install.mk +++ b/mk/install.mk @@ -104,7 +104,6 @@ install-target-$(1)-host-$(2): $$(CSREQ$$(ISTAGE)_T_$(1)_H_$(2)) $$(Q)$$(call INSTALL_LIB,$$(LIBSYNTAX_GLOB_$(1))) $$(Q)$$(call INSTALL_LIB,$$(LIBRUSTPKG_GLOB_$(1))) $$(Q)$$(call INSTALL_LIB,$$(LIBRUSTDOC_GLOB_$(1))) - $$(Q)$$(call INSTALL_LIB,$$(LIBRUSTDOCNG_GLOB_$(1))) $$(Q)$$(call INSTALL_LIB,$$(LIBRUSTI_GLOB_$(1))) $$(Q)$$(call INSTALL_LIB,$$(LIBRUST_GLOB_$(1))) $$(Q)$$(call INSTALL_LIB,libmorestack.a) @@ -140,7 +139,6 @@ install-host: $(CSREQ$(ISTAGE)_T_$(CFG_BUILD_TRIPLE)_H_$(CFG_BUILD_TRIPLE)) $(Q)$(call INSTALL,$(HB2),$(PHB),rustc$(X_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(HB2),$(PHB),rustpkg$(X_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(HB2),$(PHB),rustdoc$(X_$(CFG_BUILD_TRIPLE))) - $(Q)$(call INSTALL,$(HB2),$(PHB),rustdoc_ng$(X_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(HB2),$(PHB),rusti$(X_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(HB2),$(PHB),rust$(X_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL_LIB,$(STDLIB_GLOB_$(CFG_BUILD_TRIPLE))) @@ -151,7 +149,6 @@ install-host: $(CSREQ$(ISTAGE)_T_$(CFG_BUILD_TRIPLE)_H_$(CFG_BUILD_TRIPLE)) $(Q)$(call INSTALL_LIB,$(LIBRUST_GLOB_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL_LIB,$(LIBRUSTPKG_GLOB_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL_LIB,$(LIBRUSTDOC_GLOB_$(CFG_BUILD_TRIPLE))) - $(Q)$(call INSTALL_LIB,$(LIBRUSTDOCNG_GLOB_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(HL),$(PHL),$(CFG_RUNTIME_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(HL),$(PHL),$(CFG_RUSTLLVM_$(CFG_BUILD_TRIPLE))) $(Q)$(call INSTALL,$(S)/man, $(PREFIX_ROOT)/share/man/man1,rust.1) @@ -172,7 +169,6 @@ uninstall: $(Q)rm -f $(PHB)/rusti$(X_$(CFG_BUILD_TRIPLE)) $(Q)rm -f $(PHB)/rust$(X_$(CFG_BUILD_TRIPLE)) $(Q)rm -f $(PHB)/rustdoc$(X_$(CFG_BUILD_TRIPLE)) - $(Q)rm -f $(PHB)/rustdoc_ng$(X_$(CFG_BUILD_TRIPLE)) $(Q)rm -f $(PHL)/$(CFG_RUSTLLVM_$(CFG_BUILD_TRIPLE)) $(Q)rm -f $(PHL)/$(CFG_RUNTIME_$(CFG_BUILD_TRIPLE)) $(Q)for i in \ @@ -182,7 +178,6 @@ uninstall: $(call HOST_LIB_FROM_HL_GLOB,$(LIBSYNTAX_GLOB_$(CFG_BUILD_TRIPLE))) \ $(call HOST_LIB_FROM_HL_GLOB,$(LIBRUSTPKG_GLOB_$(CFG_BUILD_TRIPLE))) \ $(call HOST_LIB_FROM_HL_GLOB,$(LIBRUSTDOC_GLOB_$(CFG_BUILD_TRIPLE))) \ - $(call HOST_LIB_FROM_HL_GLOB,$(LIBRUSTDOCNG_GLOB_$(CFG_BUILD_TRIPLE))) \ $(call HOST_LIB_FROM_HL_GLOB,$(LIBRUSTI_GLOB_$(CFG_BUILD_TRIPLE))) \ $(call HOST_LIB_FROM_HL_GLOB,$(LIBRUST_GLOB_$(CFG_BUILD_TRIPLE))) \ ; \ diff --git a/mk/tests.mk b/mk/tests.mk index 14b06bf047e..9fe163e509b 100644 --- a/mk/tests.mk +++ b/mk/tests.mk @@ -15,7 +15,7 @@ # The names of crates that must be tested TEST_TARGET_CRATES = std extra -TEST_HOST_CRATES = rust rusti rustpkg rustc rustdoc rustdocng syntax +TEST_HOST_CRATES = rust rusti rustpkg rustc rustdoc syntax TEST_CRATES = $(TEST_TARGET_CRATES) $(TEST_HOST_CRATES) # Markdown files under doc/ that should have their code extracted and run @@ -393,14 +393,6 @@ $(3)/stage$(1)/test/rustdoctest-$(2)$$(X_$(2)): \ @$$(call E, compile_and_link: $$@) $$(STAGE$(1)_T_$(2)_H_$(3)) -o $$@ $$< --test -$(3)/stage$(1)/test/rustdocngtest-$(2)$$(X_$(2)): \ - $$(RUSTDOCNG_LIB) $$(RUSTDOCNG_INPUTS) \ - $$(SREQ$(1)_T_$(2)_H_$(3)) \ - $$(TLIB$(1)_T_$(2)_H_$(3))/$$(CFG_LIBSYNTAX_$(2)) \ - $$(TLIB$(1)_T_$(2)_H_$(3))/$$(CFG_LIBRUSTC_$(2)) - @$$(call E, compile_and_link: $$@) - $$(STAGE$(1)_T_$(2)_H_$(3)) -o $$@ $$< --test - endef $(foreach host,$(CFG_HOST_TRIPLES), \ diff --git a/mk/tools.mk b/mk/tools.mk index 212b7e570f7..09c3de01478 100644 --- a/mk/tools.mk +++ b/mk/tools.mk @@ -23,11 +23,6 @@ RUSTPKG_INPUTS := $(wildcard $(S)src/librustpkg/*.rs) RUSTDOC_LIB := $(S)src/librustdoc/rustdoc.rs RUSTDOC_INPUTS := $(wildcard $(S)src/librustdoc/*.rs) -# rustdoc_ng, the next generation documentation tool - -RUSTDOCNG_LIB := $(S)src/rustdoc_ng/rustdoc_ng.rs -RUSTDOCNG_INPUTS := $(wildcard $(S)src/rustdoc_ng/*.rs) - # Rusti, the JIT REPL RUSTI_LIB := $(S)src/librusti/rusti.rs RUSTI_INPUTS := $(wildcard $(S)src/librusti/*.rs) @@ -83,24 +78,6 @@ $$(TBIN$(1)_T_$(4)_H_$(3))/rustdoc$$(X_$(4)): \ @$$(call E, compile_and_link: $$@) $$(STAGE$(1)_T_$(4)_H_$(3)) --cfg rustdoc -o $$@ $$< -$$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(4)): \ - $$(RUSTDOCNG_LIB) $$(RUSTDOCNG_INPUTS) \ - $$(SREQ$(1)_T_$(4)_H_$(3)) \ - $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTC_$(4)) \ - | $$(TLIB$(1)_T_$(4)_H_$(3))/ - @$$(call E, compile_and_link: $$@) - $$(call REMOVE_ALL_OLD_GLOB_MATCHES_EXCEPT,$$(dir $$@),$(LIBRUSTDOCNG_GLOB_$(4)),$$(notdir $$@)) - $$(STAGE$(1)_T_$(4)_H_$(3)) --out-dir $$(@D) $$< && touch $$@ - $$(call LIST_ALL_OLD_GLOB_MATCHES_EXCEPT,$$(dir $$@),$(LIBRUSTDOCNG_GLOB_$(4)),$$(notdir $$@)) - -$$(TBIN$(1)_T_$(4)_H_$(3))/rustdoc_ng$$(X_$(4)): \ - $$(DRIVER_CRATE) \ - $$(TSREQ$(1)_T_$(4)_H_$(3)) \ - $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(4)) \ - | $$(TBIN$(1)_T_$(4)_H_$(3))/ - @$$(call E, compile_and_link: $$@) - $$(STAGE$(1)_T_$(4)_H_$(3)) --cfg rustdoc_ng -o $$@ $$< - $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTI_$(4)): \ $$(RUSTI_LIB) $$(RUSTI_INPUTS) \ $$(SREQ$(1)_T_$(4)_H_$(3)) \ @@ -125,7 +102,6 @@ $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUST_$(4)): \ $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTPKG_$(4)) \ $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTI_$(4)) \ $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTDOC_$(4)) \ - $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(4)) \ $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTC_$(4)) \ | $$(TLIB$(1)_T_$(4)_H_$(3))/ @$$(call E, compile_and_link: $$@) @@ -195,27 +171,6 @@ $$(HBIN$(2)_H_$(4))/rustdoc$$(X_$(4)): \ @$$(call E, cp: $$@) $$(Q)cp $$< $$@ -$$(HLIB$(2)_H_$(4))/$(CFG_LIBRUSTDOCNG_$(4)): \ - $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTDOCNG_$(4)) \ - $$(HLIB$(2)_H_$(4))/$(CFG_LIBRUSTC_$(4)) \ - $$(HSREQ$(2)_H_$(4)) \ - | $$(HLIB$(2)_H_$(4))/ - @$$(call E, cp: $$@) - $$(call REMOVE_ALL_OLD_GLOB_MATCHES_EXCEPT,$$(dir $$@),$(LIBRUSTDOCNG_GLOB_$(4)),$$(notdir $$@)) - $$(Q)cp $$< $$@ - $$(call LIST_ALL_OLD_GLOB_MATCHES_EXCEPT,$$(dir $$@),$(LIBRUSTDOCNG_GLOB_$(4)),$$(notdir $$@)) - $$(Q)cp -R $$(TLIB$(1)_T_$(4)_H_$(3))/$(LIBRUSTDOCNG_GLOB_$(4)) \ - $$(wildcard $$(TLIB$(1)_T_$(4)_H_$(3))/$(LIBRUSTDOCNG_DSYM_GLOB_$(4))) \ - $$(HLIB$(2)_H_$(4)) - -$$(HBIN$(2)_H_$(4))/rustdoc_ng$$(X_$(4)): \ - $$(TBIN$(1)_T_$(4)_H_$(3))/rustdoc_ng$$(X_$(4)) \ - $$(HLIB$(2)_H_$(4))/$(CFG_LIBRUSTDOCNG_$(4)) \ - $$(HSREQ$(2)_H_$(4)) \ - | $$(HBIN$(2)_H_$(4))/ - @$$(call E, cp: $$@) - $$(Q)cp $$< $$@ - $$(HLIB$(2)_H_$(4))/$(CFG_LIBRUSTI_$(4)): \ $$(TLIB$(1)_T_$(4)_H_$(3))/$(CFG_LIBRUSTI_$(4)) \ $$(HLIB$(2)_H_$(4))/$(CFG_LIBRUSTC_$(4)) \ diff --git a/src/librust/rust.rs b/src/librust/rust.rs index 01902c356a7..eb82cfcc0b2 100644 --- a/src/librust/rust.rs +++ b/src/librust/rust.rs @@ -92,7 +92,7 @@ static COMMANDS: &'static [Command<'static>] = &'static [ cmd: "doc", action: CallMain("rustdoc", rustdoc::main_args), usage_line: "generate documentation from doc comments", - usage_full: UsgCall(rustdoc::config::usage), + usage_full: UsgCall(rustdoc_help), }, Command { cmd: "pkg", @@ -122,6 +122,10 @@ fn rustc_help() { rustc::usage(os::args()[0].clone()) } +fn rustdoc_help() { + rustdoc::usage(os::args()[0].clone()) +} + fn find_cmd(command_string: &str) -> Option { do COMMANDS.iter().find |command| { command.cmd == command_string diff --git a/src/librustdoc/astsrv.rs b/src/librustdoc/astsrv.rs deleted file mode 100644 index b2b7599aae3..00000000000 --- a/src/librustdoc/astsrv.rs +++ /dev/null @@ -1,186 +0,0 @@ -// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -/*! -Provides all access to AST-related, non-sendable info - -Rustdoc is intended to be parallel, and the rustc AST is filled with -shared boxes. The AST service attempts to provide a single place to -query AST-related information, shielding the rest of Rustdoc from its -non-sendableness. -*/ - - -use parse; - -use std::cell::Cell; -use std::comm::{stream, SharedChan, Port}; -use std::task; -use rustc::driver::driver; -use rustc::driver::session::Session; -use rustc::driver::session::{basic_options, options}; -use rustc::front; -use syntax::ast; -use syntax::ast_map; -use syntax::ast_util; -use syntax; - -pub struct Ctxt { - ast: @ast::Crate, - ast_map: ast_map::map -} - -type SrvOwner<'self,T> = &'self fn(srv: Srv) -> T; -pub type CtxtHandler = ~fn(ctxt: Ctxt) -> T; -type Parser = ~fn(Session, s: @str) -> @ast::Crate; - -enum Msg { - HandleRequest(~fn(Ctxt)), - Exit -} - -#[deriving(Clone)] -pub struct Srv { - ch: SharedChan -} - -pub fn from_str(source: ~str, owner: SrvOwner) -> T { - run(owner, source.clone(), parse::from_str_sess) -} - -pub fn from_file(file: ~str, owner: SrvOwner) -> T { - run(owner, file.clone(), |sess, f| parse::from_file_sess(sess, &Path(f))) -} - -fn run(owner: SrvOwner, source: ~str, parse: Parser) -> T { - - let (po, ch) = stream(); - - let source = Cell::new(source); - let parse = Cell::new(parse); - do task::spawn { - act(&po, source.take().to_managed(), parse.take()); - } - - let srv_ = Srv { - ch: SharedChan::new(ch) - }; - - let res = owner(srv_.clone()); - srv_.ch.send(Exit); - res -} - -fn act(po: &Port, source: @str, parse: Parser) { - let sess = build_session(); - - let ctxt = build_ctxt( - sess, - parse(sess, source) - ); - - let mut keep_going = true; - while keep_going { - match po.recv() { - HandleRequest(f) => { - f(ctxt); - } - Exit => { - keep_going = false; - } - } - } -} - -pub fn exec( - srv: Srv, - f: ~fn(ctxt: Ctxt) -> T -) -> T { - let (po, ch) = stream(); - let msg = HandleRequest(|ctxt| ch.send(f(ctxt))); - srv.ch.send(msg); - po.recv() -} - -fn assign_node_ids(crate: @ast::Crate) -> @ast::Crate { - let next_id = @mut 0; - let fold = ast_util::node_id_assigner(|| { - let i = *next_id; - *next_id += 1; - i - }); - @fold.fold_crate(crate) -} - -fn build_ctxt(sess: Session, - ast: @ast::Crate) -> Ctxt { - - use rustc::front::config; - - let ast = syntax::ext::expand::inject_std_macros(sess.parse_sess, - sess.opts.cfg.clone(), - ast); - let ast = config::strip_unconfigured_items(ast); - let ast = syntax::ext::expand::expand_crate(sess.parse_sess, - sess.opts.cfg.clone(), - ast); - let ast = front::test::modify_for_testing(sess, ast); - let ast = assign_node_ids(ast); - let ast_map = ast_map::map_crate(sess.diagnostic(), ast); - - Ctxt { - ast: ast, - ast_map: ast_map, - } -} - -fn build_session() -> Session { - let sopts: @options = basic_options(); - let emitter = syntax::diagnostic::emit; - - let session = driver::build_session(sopts, emitter); - session -} - -#[test] -fn should_prune_unconfigured_items() { - let source = ~"#[cfg(shut_up_and_leave_me_alone)]fn a() { }"; - do from_str(source) |srv| { - do exec(srv) |ctxt| { - // one item: the __std_macros secret module - assert_eq!(ctxt.ast.module.items.len(), 1); - } - } -} - -#[test] -fn srv_should_build_ast_map() { - let source = ~"fn a() { }"; - do from_str(source) |srv| { - do exec(srv) |ctxt| { - assert!(!ctxt.ast_map.is_empty()) - }; - } -} - -#[test] -fn should_ignore_external_import_paths_that_dont_exist() { - let source = ~"use forble; use forble::bippy;"; - from_str(source, |_srv| { } ) -} - -#[test] -fn srv_should_return_request_result() { - let source = ~"fn a() { }"; - do from_str(source) |srv| { - let result = exec(srv, |_ctxt| 1000 ); - assert_eq!(result, 1000); - } -} diff --git a/src/librustdoc/attr_parser.rs b/src/librustdoc/attr_parser.rs deleted file mode 100644 index ce8d1977443..00000000000 --- a/src/librustdoc/attr_parser.rs +++ /dev/null @@ -1,149 +0,0 @@ -// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -/*! -Attribute parsing - -The attribute parser provides methods for pulling documentation out of -an AST's attributes. -*/ - - -use syntax::ast; -use syntax::attr; -use syntax::attr::{AttrMetaMethods, AttributeMethods}; - -pub struct CrateAttrs { - name: Option<~str> -} - -fn doc_metas(attrs: ~[ast::Attribute]) -> ~[@ast::MetaItem] { - attrs.iter() - .filter(|at| "doc" == at.name()) - .map(|at| at.desugar_doc().meta()) - .collect() -} - -pub fn parse_crate(attrs: ~[ast::Attribute]) -> CrateAttrs { - let link_metas = attr::find_linkage_metas(attrs); - let name = attr::last_meta_item_value_str_by_name(link_metas, "name"); - - CrateAttrs { - name: name.map(|s| s.to_owned()) - } -} - -pub fn parse_desc(attrs: ~[ast::Attribute]) -> Option<~str> { - let doc_strs = do doc_metas(attrs).move_iter().filter_map |meta| { - meta.value_str() - }.collect::<~[@str]>(); - if doc_strs.is_empty() { - None - } else { - Some(doc_strs.connect("\n")) - } -} - -pub fn parse_hidden(attrs: ~[ast::Attribute]) -> bool { - let r = doc_metas(attrs); - do r.iter().any |meta| { - match meta.meta_item_list() { - Some(metas) => attr::contains_name(metas, "hidden"), - None => false - } - } -} - -#[cfg(test)] -mod test { - use syntax::ast; - use syntax; - use super::{parse_hidden, parse_crate, parse_desc}; - - fn parse_attributes(source: @str) -> ~[ast::Attribute] { - use syntax::parse; - use syntax::parse::attr::parser_attr; - - let parse_sess = syntax::parse::new_parse_sess(None); - let parser = parse::new_parser_from_source_str( - parse_sess, ~[], @"-", source); - - parser.parse_outer_attributes() - } - - - #[test] - fn should_extract_crate_name_from_link_attribute() { - let source = @"#[link(name = \"snuggles\")]"; - let attrs = parse_attributes(source); - let attrs = parse_crate(attrs); - assert!(attrs.name == Some(~"snuggles")); - } - - #[test] - fn should_not_extract_crate_name_if_no_link_attribute() { - let source = @""; - let attrs = parse_attributes(source); - let attrs = parse_crate(attrs); - assert!(attrs.name == None); - } - - #[test] - fn should_not_extract_crate_name_if_no_name_value_in_link_attribute() { - let source = @"#[link(whatever)]"; - let attrs = parse_attributes(source); - let attrs = parse_crate(attrs); - assert!(attrs.name == None); - } - - #[test] - fn parse_desc_should_handle_undocumented_mods() { - let source = @""; - let attrs = parse_attributes(source); - let attrs = parse_desc(attrs); - assert!(attrs == None); - } - - #[test] - fn parse_desc_should_parse_simple_doc_attributes() { - let source = @"#[doc = \"basic\"]"; - let attrs = parse_attributes(source); - let attrs = parse_desc(attrs); - assert!(attrs == Some(~"basic")); - } - - #[test] - fn should_parse_hidden_attribute() { - let source = @"#[doc(hidden)]"; - let attrs = parse_attributes(source); - assert!(parse_hidden(attrs) == true); - } - - #[test] - fn should_parse_hidden_attribute_with_other_docs() { - let source = @"#[doc = \"foo\"] #[doc(hidden)] #[doc = \"foo\"]"; - let attrs = parse_attributes(source); - assert!(parse_hidden(attrs) == true); - } - - #[test] - fn should_not_parse_non_hidden_attribute() { - let source = @"#[doc = \"\"]"; - let attrs = parse_attributes(source); - assert!(parse_hidden(attrs) == false); - } - - #[test] - fn should_concatenate_multiple_doc_comments() { - let source = @"/// foo\n/// bar"; - let desc = parse_desc(parse_attributes(source)); - assert!(desc == Some(~" foo\n bar")); - } -} diff --git a/src/librustdoc/attr_pass.rs b/src/librustdoc/attr_pass.rs deleted file mode 100644 index bd8d9a65cd3..00000000000 --- a/src/librustdoc/attr_pass.rs +++ /dev/null @@ -1,326 +0,0 @@ -// Copyright 2012 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -/*! -The attribute parsing pass - -Traverses the document tree, pulling relevant documention out of the -corresponding AST nodes. The information gathered here is the basis -of the natural-language documentation for a crate. -*/ - - -use astsrv; -use attr_parser; -use doc::ItemUtils; -use doc; -use extract::to_str; -use fold::Fold; -use fold; -use pass::Pass; - -use syntax::ast; -use syntax::ast_map; - -pub fn mk_pass() -> Pass { - Pass { - name: ~"attr", - f: run - } -} - -pub fn run( - srv: astsrv::Srv, - doc: doc::Doc -) -> doc::Doc { - let fold = Fold { - ctxt: srv.clone(), - fold_crate: fold_crate, - fold_item: fold_item, - fold_enum: fold_enum, - fold_trait: fold_trait, - fold_impl: fold_impl, - .. fold::default_any_fold(srv) - }; - (fold.fold_doc)(&fold, doc) -} - -fn fold_crate( - fold: &fold::Fold, - doc: doc::CrateDoc -) -> doc::CrateDoc { - - let srv = fold.ctxt.clone(); - let doc = fold::default_seq_fold_crate(fold, doc); - - let attrs = do astsrv::exec(srv) |ctxt| { - let attrs = ctxt.ast.attrs.clone(); - attr_parser::parse_crate(attrs) - }; - - doc::CrateDoc { - topmod: doc::ModDoc { - item: doc::ItemDoc { - name: attrs.name.clone().unwrap_or(doc.topmod.name_()), - .. doc.topmod.item.clone() - }, - .. doc.topmod.clone() - } - } -} - -fn fold_item( - fold: &fold::Fold, - doc: doc::ItemDoc -) -> doc::ItemDoc { - - let srv = fold.ctxt.clone(); - let doc = fold::default_seq_fold_item(fold, doc); - - let desc = if doc.id == ast::CRATE_NODE_ID { - // This is the top-level mod, use the crate attributes - do astsrv::exec(srv) |ctxt| { - attr_parser::parse_desc(ctxt.ast.attrs.clone()) - } - } else { - parse_item_attrs(srv, doc.id, attr_parser::parse_desc) - }; - - doc::ItemDoc { - desc: desc, - .. doc - } -} - -fn parse_item_attrs( - srv: astsrv::Srv, - id: doc::AstId, - parse_attrs: ~fn(a: ~[ast::Attribute]) -> T) -> T { - do astsrv::exec(srv) |ctxt| { - let attrs = match ctxt.ast_map.get_copy(&id) { - ast_map::node_item(item, _) => item.attrs.clone(), - ast_map::node_foreign_item(item, _, _, _) => item.attrs.clone(), - _ => fail!("parse_item_attrs: not an item") - }; - parse_attrs(attrs) - } -} - -fn fold_enum( - fold: &fold::Fold, - doc: doc::EnumDoc -) -> doc::EnumDoc { - - let srv = fold.ctxt.clone(); - let doc_id = doc.id(); - let doc = fold::default_seq_fold_enum(fold, doc); - - doc::EnumDoc { - variants: do doc.variants.iter().map |variant| { - let variant = (*variant).clone(); - let desc = { - let variant = variant.clone(); - do astsrv::exec(srv.clone()) |ctxt| { - match ctxt.ast_map.get_copy(&doc_id) { - ast_map::node_item(@ast::item { - node: ast::item_enum(ref enum_definition, _), _ - }, _) => { - let ast_variant = - (*enum_definition.variants.iter().find(|v| { - to_str(v.node.name) == variant.name - }).unwrap()).clone(); - - attr_parser::parse_desc( - ast_variant.node.attrs.clone()) - } - _ => { - fail!("Enum variant %s has id that's not bound to an enum item", - variant.name) - } - } - } - }; - - doc::VariantDoc { - desc: desc, - .. variant - } - }.collect(), - .. doc - } -} - -fn fold_trait( - fold: &fold::Fold, - doc: doc::TraitDoc -) -> doc::TraitDoc { - let srv = fold.ctxt.clone(); - let doc = fold::default_seq_fold_trait(fold, doc); - - doc::TraitDoc { - methods: merge_method_attrs(srv, doc.id(), doc.methods.clone()), - .. doc - } -} - -fn merge_method_attrs( - srv: astsrv::Srv, - item_id: doc::AstId, - docs: ~[doc::MethodDoc] -) -> ~[doc::MethodDoc] { - - // Create an assoc list from method name to attributes - let attrs: ~[(~str, Option<~str>)] = do astsrv::exec(srv) |ctxt| { - match ctxt.ast_map.get_copy(&item_id) { - ast_map::node_item(@ast::item { - node: ast::item_trait(_, _, ref methods), _ - }, _) => { - methods.iter().map(|method| { - match (*method).clone() { - ast::required(ty_m) => { - (to_str(ty_m.ident), - attr_parser::parse_desc(ty_m.attrs.clone())) - } - ast::provided(m) => { - (to_str(m.ident), attr_parser::parse_desc(m.attrs.clone())) - } - } - }).collect() - } - ast_map::node_item(@ast::item { - node: ast::item_impl(_, _, _, ref methods), _ - }, _) => { - methods.iter().map(|method| { - (to_str(method.ident), - attr_parser::parse_desc(method.attrs.clone())) - }).collect() - } - _ => fail!("unexpected item") - } - }; - - do docs.iter().zip(attrs.iter()).map |(doc, attrs)| { - assert!(doc.name == attrs.first()); - let desc = attrs.second(); - - doc::MethodDoc { - desc: desc, - .. (*doc).clone() - } - }.collect() -} - - -fn fold_impl( - fold: &fold::Fold, - doc: doc::ImplDoc -) -> doc::ImplDoc { - let srv = fold.ctxt.clone(); - let doc = fold::default_seq_fold_impl(fold, doc); - - doc::ImplDoc { - methods: merge_method_attrs(srv, doc.id(), doc.methods.clone()), - .. doc - } -} - -#[cfg(test)] -mod test { - - use astsrv; - use attr_pass::run; - use doc; - use extract; - - fn mk_doc(source: ~str) -> doc::Doc { - do astsrv::from_str(source.clone()) |srv| { - let doc = extract::from_srv(srv.clone(), ~""); - run(srv.clone(), doc) - } - } - - #[test] - fn should_replace_top_module_name_with_crate_name() { - let doc = mk_doc(~"#[link(name = \"bond\")];"); - assert!(doc.cratemod().name_() == ~"bond"); - } - - #[test] - fn should_should_extract_mod_attributes() { - let doc = mk_doc(~"#[doc = \"test\"] mod a { }"); - // hidden __std_macros module at the start. - assert!(doc.cratemod().mods()[1].desc() == Some(~"test")); - } - - #[test] - fn should_extract_top_mod_attributes() { - let doc = mk_doc(~"#[doc = \"test\"];"); - assert!(doc.cratemod().desc() == Some(~"test")); - } - - #[test] - fn should_extract_foreign_fn_attributes() { - let doc = mk_doc(~"extern { #[doc = \"test\"] fn a(); }"); - assert!(doc.cratemod().nmods()[0].fns[0].desc() == Some(~"test")); - } - - #[test] - fn should_extract_fn_attributes() { - let doc = mk_doc(~"#[doc = \"test\"] fn a() -> int { }"); - assert!(doc.cratemod().fns()[0].desc() == Some(~"test")); - } - - #[test] - fn should_extract_enum_docs() { - let doc = mk_doc(~"#[doc = \"b\"]\ - enum a { v }"); - debug!("%?", doc); - assert!(doc.cratemod().enums()[0].desc() == Some(~"b")); - } - - #[test] - fn should_extract_variant_docs() { - let doc = mk_doc(~"enum a { #[doc = \"c\"] v }"); - assert!(doc.cratemod().enums()[0].variants[0].desc == Some(~"c")); - } - - #[test] - fn should_extract_trait_docs() { - let doc = mk_doc(~"#[doc = \"whatever\"] trait i { fn a(); }"); - assert!(doc.cratemod().traits()[0].desc() == Some(~"whatever")); - } - - #[test] - fn should_extract_trait_method_docs() { - let doc = mk_doc( - ~"trait i {\ - #[doc = \"desc\"]\ - fn f(a: bool) -> bool;\ - }"); - assert!(doc.cratemod().traits()[0].methods[0].desc == Some(~"desc")); - } - - #[test] - fn should_extract_impl_docs() { - let doc = mk_doc( - ~"#[doc = \"whatever\"] impl int { fn a() { } }"); - assert!(doc.cratemod().impls()[0].desc() == Some(~"whatever")); - } - - #[test] - fn should_extract_impl_method_docs() { - let doc = mk_doc( - ~"impl int {\ - #[doc = \"desc\"]\ - fn f(a: bool) -> bool { }\ - }"); - assert!(doc.cratemod().impls()[0].methods[0].desc == Some(~"desc")); - } -} diff --git a/src/librustdoc/clean.rs b/src/librustdoc/clean.rs new file mode 100644 index 00000000000..97a599196e7 --- /dev/null +++ b/src/librustdoc/clean.rs @@ -0,0 +1,1094 @@ +// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! This module contains the "cleaned" pieces of the AST, and the functions +//! that clean them. + +use its = syntax::parse::token::ident_to_str; + +use syntax; +use syntax::ast; +use syntax::attr::AttributeMethods; + +use std; +use doctree; +use visit_ast; +use std::local_data; + +pub trait Clean { + fn clean(&self) -> T; +} + +impl, U> Clean<~[U]> for ~[T] { + fn clean(&self) -> ~[U] { + self.iter().map(|x| x.clean()).collect() + } +} +impl, U> Clean for @T { + fn clean(&self) -> U { + (**self).clean() + } +} + +impl, U> Clean> for Option { + fn clean(&self) -> Option { + match self { + &None => None, + &Some(ref v) => Some(v.clean()) + } + } +} + +impl, U> Clean<~[U]> for syntax::opt_vec::OptVec { + fn clean(&self) -> ~[U] { + match self { + &syntax::opt_vec::Empty => ~[], + &syntax::opt_vec::Vec(ref v) => v.clean() + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Crate { + name: ~str, + module: Option, +} + +impl Clean for visit_ast::RustdocVisitor { + fn clean(&self) -> Crate { + use syntax::attr::{find_linkage_metas, last_meta_item_value_str_by_name}; + let maybe_meta = last_meta_item_value_str_by_name(find_linkage_metas(self.attrs), "name"); + + Crate { + name: match maybe_meta { + Some(x) => x.to_owned(), + None => fail!("rustdoc_ng requires a #[link(name=\"foo\")] crate attribute"), + }, + module: Some(self.module.clean()), + } + } +} + +/// Anything with a source location and set of attributes and, optionally, a +/// name. That is, anything that can be documented. This doesn't correspond +/// directly to the AST's concept of an item; it's a strict superset. +#[deriving(Clone, Encodable, Decodable)] +pub struct Item { + /// Stringified span + source: ~str, + /// Not everything has a name. E.g., impls + name: Option<~str>, + attrs: ~[Attribute], + inner: ItemEnum, + visibility: Option, + id: ast::NodeId, +} + +impl Item { + /// Finds the `doc` attribute as a List and returns the list of attributes + /// nested inside. + pub fn doc_list<'a>(&'a self) -> Option<&'a [Attribute]> { + for attr in self.attrs.iter() { + match *attr { + List(~"doc", ref list) => { return Some(list.as_slice()); } + _ => {} + } + } + return None; + } + + /// Finds the `doc` attribute as a NameValue and returns the corresponding + /// value found. + pub fn doc_value<'a>(&'a self) -> Option<&'a str> { + for attr in self.attrs.iter() { + match *attr { + NameValue(~"doc", ref v) => { return Some(v.as_slice()); } + _ => {} + } + } + return None; + } + + pub fn is_mod(&self) -> bool { + match self.inner { ModuleItem(*) => true, _ => false } + } + pub fn is_trait(&self) -> bool { + match self.inner { TraitItem(*) => true, _ => false } + } + pub fn is_struct(&self) -> bool { + match self.inner { StructItem(*) => true, _ => false } + } + pub fn is_enum(&self) -> bool { + match self.inner { EnumItem(*) => true, _ => false } + } + pub fn is_fn(&self) -> bool { + match self.inner { FunctionItem(*) => true, _ => false } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum ItemEnum { + StructItem(Struct), + EnumItem(Enum), + FunctionItem(Function), + ModuleItem(Module), + TypedefItem(Typedef), + StaticItem(Static), + TraitItem(Trait), + ImplItem(Impl), + ViewItemItem(ViewItem), + TyMethodItem(TyMethod), + MethodItem(Method), + StructFieldItem(StructField), + VariantItem(Variant), +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Module { + items: ~[Item], +} + +impl Clean for doctree::Module { + fn clean(&self) -> Item { + let name = if self.name.is_some() { + self.name.unwrap().clean() + } else { + ~"" + }; + Item { + name: Some(name), + attrs: self.attrs.clean(), + source: self.where.clean(), + visibility: self.vis.clean(), + id: self.id, + inner: ModuleItem(Module { + items: std::vec::concat(&[self.structs.clean(), + self.enums.clean(), self.fns.clean(), + self.mods.clean(), self.typedefs.clean(), + self.statics.clean(), self.traits.clean(), + self.impls.clean(), self.view_items.clean()]) + }) + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum Attribute { + Word(~str), + List(~str, ~[Attribute]), + NameValue(~str, ~str) +} + +impl Clean for ast::MetaItem { + fn clean(&self) -> Attribute { + match self.node { + ast::MetaWord(s) => Word(s.to_owned()), + ast::MetaList(ref s, ref l) => List(s.to_owned(), l.clean()), + ast::MetaNameValue(s, ref v) => NameValue(s.to_owned(), lit_to_str(v)) + } + } +} + +impl Clean for ast::Attribute { + fn clean(&self) -> Attribute { + self.desugar_doc().node.value.clean() + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct TyParam { + name: ~str, + id: ast::NodeId, + bounds: ~[TyParamBound] +} + +impl Clean for ast::TyParam { + fn clean(&self) -> TyParam { + TyParam { + name: self.ident.clean(), + id: self.id, + bounds: self.bounds.clean(), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum TyParamBound { + RegionBound, + TraitBound(Type) +} + +impl Clean for ast::TyParamBound { + fn clean(&self) -> TyParamBound { + match *self { + ast::RegionTyParamBound => RegionBound, + ast::TraitTyParamBound(ref t) => TraitBound(t.clean()), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Lifetime(~str); + +impl Clean for ast::Lifetime { + fn clean(&self) -> Lifetime { + Lifetime(self.ident.clean()) + } +} + +// maybe use a Generic enum and use ~[Generic]? +#[deriving(Clone, Encodable, Decodable)] +pub struct Generics { + lifetimes: ~[Lifetime], + type_params: ~[TyParam] +} + +impl Generics { + fn new() -> Generics { + Generics { + lifetimes: ~[], + type_params: ~[] + } + } +} + +impl Clean for ast::Generics { + fn clean(&self) -> Generics { + Generics { + lifetimes: self.lifetimes.clean(), + type_params: self.ty_params.clean(), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Method { + generics: Generics, + self_: SelfTy, + purity: ast::purity, + decl: FnDecl, +} + +impl Clean for ast::method { + fn clean(&self) -> Item { + Item { + name: Some(self.ident.clean()), + attrs: self.attrs.clean(), + source: self.span.clean(), + id: self.self_id.clone(), + visibility: None, + inner: MethodItem(Method { + generics: self.generics.clean(), + self_: self.explicit_self.clean(), + purity: self.purity.clone(), + decl: self.decl.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct TyMethod { + purity: ast::purity, + decl: FnDecl, + generics: Generics, + self_: SelfTy, +} + +impl Clean for ast::TypeMethod { + fn clean(&self) -> Item { + Item { + name: Some(self.ident.clean()), + attrs: self.attrs.clean(), + source: self.span.clean(), + id: self.id, + visibility: None, + inner: TyMethodItem(TyMethod { + purity: self.purity.clone(), + decl: self.decl.clean(), + self_: self.explicit_self.clean(), + generics: self.generics.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum SelfTy { + SelfStatic, + SelfValue, + SelfBorrowed(Option, Mutability), + SelfManaged(Mutability), + SelfOwned, +} + +impl Clean for ast::explicit_self { + fn clean(&self) -> SelfTy { + match self.node { + ast::sty_static => SelfStatic, + ast::sty_value => SelfValue, + ast::sty_uniq => SelfOwned, + ast::sty_region(lt, mt) => SelfBorrowed(lt.clean(), mt.clean()), + ast::sty_box(mt) => SelfManaged(mt.clean()), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Function { + decl: FnDecl, + generics: Generics, +} + +impl Clean for doctree::Function { + fn clean(&self) -> Item { + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + visibility: self.vis.clean(), + id: self.id, + inner: FunctionItem(Function { + decl: self.decl.clean(), + generics: self.generics.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct ClosureDecl { + sigil: ast::Sigil, + region: Option, + lifetimes: ~[Lifetime], + decl: FnDecl, + onceness: ast::Onceness, + purity: ast::purity, + bounds: ~[TyParamBound] +} + +impl Clean for ast::TyClosure { + fn clean(&self) -> ClosureDecl { + ClosureDecl { + sigil: self.sigil, + region: self.region.clean(), + lifetimes: self.lifetimes.clean(), + decl: self.decl.clean(), + onceness: self.onceness, + purity: self.purity, + bounds: match self.bounds { + Some(ref x) => x.clean(), + None => ~[] + }, + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct FnDecl { + inputs: ~[Argument], + output: Type, + cf: RetStyle, + attrs: ~[Attribute] +} + +impl Clean for ast::fn_decl { + fn clean(&self) -> FnDecl { + FnDecl { + inputs: self.inputs.iter().map(|x| x.clean()).collect(), + output: (self.output.clean()), + cf: self.cf.clean(), + attrs: ~[] + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Argument { + type_: Type, + name: ~str, + id: ast::NodeId +} + +impl Clean for ast::arg { + fn clean(&self) -> Argument { + Argument { + name: name_from_pat(self.pat), + type_: (self.ty.clean()), + id: self.id + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum RetStyle { + NoReturn, + Return +} + +impl Clean for ast::ret_style { + fn clean(&self) -> RetStyle { + match *self { + ast::return_val => Return, + ast::noreturn => NoReturn + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Trait { + methods: ~[TraitMethod], + generics: Generics, + parents: ~[Type], +} + +impl Clean for doctree::Trait { + fn clean(&self) -> Item { + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + id: self.id, + visibility: self.vis.clean(), + inner: TraitItem(Trait { + methods: self.methods.clean(), + generics: self.generics.clean(), + parents: self.parents.clean(), + }), + } + } +} + +impl Clean for ast::trait_ref { + fn clean(&self) -> Type { + let t = Unresolved(self.path.clean(), None, self.ref_id); + resolve_type(&t) + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum TraitMethod { + Required(Item), + Provided(Item), +} + +impl TraitMethod { + pub fn is_req(&self) -> bool { + match self { + &Required(*) => true, + _ => false, + } + } + pub fn is_def(&self) -> bool { + match self { + &Provided(*) => true, + _ => false, + } + } + pub fn item<'a>(&'a self) -> &'a Item { + match *self { + Required(ref item) => item, + Provided(ref item) => item, + } + } +} + +impl Clean for ast::trait_method { + fn clean(&self) -> TraitMethod { + match self { + &ast::required(ref t) => Required(t.clean()), + &ast::provided(ref t) => Provided(t.clean()), + } + } +} + +/// A representation of a Type suitable for hyperlinking purposes. Ideally one can get the original +/// type out of the AST/ty::ctxt given one of these, if more information is needed. Most importantly +/// it does not preserve mutability or boxes. +#[deriving(Clone, Encodable, Decodable)] +pub enum Type { + /// Most types start out as "Unresolved". It serves as an intermediate stage between cleaning + /// and type resolution. + Unresolved(Path, Option<~[TyParamBound]>, ast::NodeId), + /// structs/enums/traits (anything that'd be an ast::ty_path) + ResolvedPath { path: Path, typarams: Option<~[TyParamBound]>, id: ast::NodeId }, + /// Reference to an item in an external crate (fully qualified path) + External(~str, ~str), + // I have no idea how to usefully use this. + TyParamBinder(ast::NodeId), + /// For parameterized types, so the consumer of the JSON don't go looking + /// for types which don't exist anywhere. + Generic(ast::NodeId), + /// For references to self + Self(ast::NodeId), + /// Primitives are just the fixed-size numeric types (plus int/uint/float), and char. + Primitive(ast::prim_ty), + Closure(~ClosureDecl), + /// extern "ABI" fn + BareFunction(~BareFunctionDecl), + Tuple(~[Type]), + Vector(~Type), + FixedVector(~Type, ~str), + String, + Bool, + /// aka ty_nil + Unit, + /// aka ty_bot + Bottom, + Unique(~Type), + Managed(Mutability, ~Type), + RawPointer(Mutability, ~Type), + BorrowedRef { lifetime: Option, mutability: Mutability, type_: ~Type}, + // region, raw, other boxes, mutable +} + +impl Clean for ast::Ty { + fn clean(&self) -> Type { + use syntax::ast::*; + debug!("cleaning type `%?`", self); + let codemap = local_data::get(super::ctxtkey, |x| *x.unwrap()).sess.codemap; + debug!("span corresponds to `%s`", codemap.span_to_str(self.span)); + let t = match self.node { + ty_nil => Unit, + ty_ptr(ref m) => RawPointer(m.mutbl.clean(), ~resolve_type(&m.ty.clean())), + ty_rptr(ref l, ref m) => + BorrowedRef {lifetime: l.clean(), mutability: m.mutbl.clean(), + type_: ~resolve_type(&m.ty.clean())}, + ty_box(ref m) => Managed(m.mutbl.clean(), ~resolve_type(&m.ty.clean())), + ty_uniq(ref m) => Unique(~resolve_type(&m.ty.clean())), + ty_vec(ref m) => Vector(~resolve_type(&m.ty.clean())), + ty_fixed_length_vec(ref m, ref e) => FixedVector(~resolve_type(&m.ty.clean()), + e.span.to_src()), + ty_tup(ref tys) => Tuple(tys.iter().map(|x| resolve_type(&x.clean())).collect()), + ty_path(ref p, ref tpbs, id) => Unresolved(p.clean(), tpbs.clean(), id), + ty_closure(ref c) => Closure(~c.clean()), + ty_bare_fn(ref barefn) => BareFunction(~barefn.clean()), + ty_bot => Bottom, + ref x => fail!("Unimplemented type %?", x), + }; + resolve_type(&t) + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct StructField { + type_: Type, +} + +impl Clean for ast::struct_field { + fn clean(&self) -> Item { + let (name, vis) = match self.node.kind { + ast::named_field(id, vis) => (Some(id), Some(vis)), + _ => (None, None) + }; + Item { + name: name.clean(), + attrs: self.node.attrs.clean(), + source: self.span.clean(), + visibility: vis, + id: self.node.id, + inner: StructFieldItem(StructField { + type_: self.node.ty.clean(), + }), + } + } +} + +pub type Visibility = ast::visibility; + +impl Clean> for ast::visibility { + fn clean(&self) -> Option { + Some(*self) + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Struct { + struct_type: doctree::StructType, + generics: Generics, + fields: ~[Item], +} + +impl Clean for doctree::Struct { + fn clean(&self) -> Item { + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + id: self.id, + visibility: self.vis.clean(), + inner: StructItem(Struct { + struct_type: self.struct_type, + generics: self.generics.clean(), + fields: self.fields.clean(), + }), + } + } +} + +/// This is a more limited form of the standard Struct, different in that it +/// it lacks the things most items have (name, id, parameterization). Found +/// only as a variant in an enum. +#[deriving(Clone, Encodable, Decodable)] +pub struct VariantStruct { + struct_type: doctree::StructType, + fields: ~[Item], +} + +impl Clean for syntax::ast::struct_def { + fn clean(&self) -> VariantStruct { + VariantStruct { + struct_type: doctree::struct_type_from_def(self), + fields: self.fields.clean(), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Enum { + variants: ~[Item], + generics: Generics, +} + +impl Clean for doctree::Enum { + fn clean(&self) -> Item { + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + id: self.id, + visibility: self.vis.clean(), + inner: EnumItem(Enum { + variants: self.variants.clean(), + generics: self.generics.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Variant { + kind: VariantKind, +} + +impl Clean for doctree::Variant { + fn clean(&self) -> Item { + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + visibility: self.vis.clean(), + id: self.id, + inner: VariantItem(Variant { + kind: self.kind.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum VariantKind { + CLikeVariant, + TupleVariant(~[Type]), + StructVariant(VariantStruct), +} + +impl Clean for ast::variant_kind { + fn clean(&self) -> VariantKind { + match self { + &ast::tuple_variant_kind(ref args) => { + if args.len() == 0 { + CLikeVariant + } else { + TupleVariant(args.iter().map(|x| x.ty.clean()).collect()) + } + }, + &ast::struct_variant_kind(ref sd) => StructVariant(sd.clean()), + } + } +} + +impl Clean<~str> for syntax::codemap::Span { + fn clean(&self) -> ~str { + let cm = local_data::get(super::ctxtkey, |x| x.unwrap().clone()).sess.codemap; + cm.span_to_str(*self) + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Path { + global: bool, + segments: ~[PathSegment], +} + +impl Clean for ast::Path { + fn clean(&self) -> Path { + Path { + global: self.global, + segments: self.segments.clean() + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct PathSegment { + name: ~str, + lifetime: Option, + types: ~[Type], +} + +impl Clean for ast::PathSegment { + fn clean(&self) -> PathSegment { + PathSegment { + name: self.identifier.clean(), + lifetime: self.lifetime.clean(), + types: self.types.clean() + } + } +} + +fn path_to_str(p: &ast::Path) -> ~str { + use syntax::parse::token::interner_get; + + let mut s = ~""; + let mut first = true; + for i in p.segments.iter().map(|x| interner_get(x.identifier.name)) { + if !first || p.global { + s.push_str("::"); + } else { + first = false; + } + s.push_str(i); + } + s +} + +impl Clean<~str> for ast::Ident { + fn clean(&self) -> ~str { + its(self).to_owned() + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Typedef { + type_: Type, + generics: Generics, +} + +impl Clean for doctree::Typedef { + fn clean(&self) -> Item { + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + id: self.id.clone(), + visibility: self.vis.clean(), + inner: TypedefItem(Typedef { + type_: self.ty.clean(), + generics: self.gen.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct BareFunctionDecl { + purity: ast::purity, + generics: Generics, + decl: FnDecl, + abi: ~str +} + +impl Clean for ast::TyBareFn { + fn clean(&self) -> BareFunctionDecl { + BareFunctionDecl { + purity: self.purity, + generics: Generics { + lifetimes: self.lifetimes.clean(), + type_params: ~[], + }, + decl: self.decl.clean(), + abi: self.abis.to_str(), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Static { + type_: Type, + mutability: Mutability, + /// It's useful to have the value of a static documented, but I have no + /// desire to represent expressions (that'd basically be all of the AST, + /// which is huge!). So, have a string. + expr: ~str, +} + +impl Clean for doctree::Static { + fn clean(&self) -> Item { + debug!("claning static %s: %?", self.name.clean(), self); + Item { + name: Some(self.name.clean()), + attrs: self.attrs.clean(), + source: self.where.clean(), + id: self.id, + visibility: self.vis.clean(), + inner: StaticItem(Static { + type_: self.type_.clean(), + mutability: self.mutability.clean(), + expr: self.expr.span.to_src(), + }), + } + } +} + +#[deriving(ToStr, Clone, Encodable, Decodable)] +pub enum Mutability { + Mutable, + Immutable, +} + +impl Clean for ast::Mutability { + fn clean(&self) -> Mutability { + match self { + &ast::MutMutable => Mutable, + &ast::MutImmutable => Immutable, + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct Impl { + generics: Generics, + trait_: Option, + for_: Type, + methods: ~[Item], +} + +impl Clean for doctree::Impl { + fn clean(&self) -> Item { + Item { + name: None, + attrs: self.attrs.clean(), + source: self.where.clean(), + id: self.id, + visibility: self.vis.clean(), + inner: ImplItem(Impl { + generics: self.generics.clean(), + trait_: self.trait_.clean(), + for_: self.for_.clean(), + methods: self.methods.clean(), + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub struct ViewItem { + inner: ViewItemInner +} + +impl Clean for ast::view_item { + fn clean(&self) -> Item { + Item { + name: None, + attrs: self.attrs.clean(), + source: self.span.clean(), + id: 0, + visibility: self.vis.clean(), + inner: ViewItemItem(ViewItem { + inner: self.node.clean() + }), + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum ViewItemInner { + ExternMod(~str, Option<~str>, ~[Attribute], ast::NodeId), + Import(~[ViewPath]) +} + +impl Clean for ast::view_item_ { + fn clean(&self) -> ViewItemInner { + match self { + &ast::view_item_extern_mod(ref i, ref p, ref mi, ref id) => + ExternMod(i.clean(), p.map(|x| x.to_owned()), mi.clean(), *id), + &ast::view_item_use(ref vp) => Import(vp.clean()) + } + } +} + +#[deriving(Clone, Encodable, Decodable)] +pub enum ViewPath { + SimpleImport(~str, Path, ast::NodeId), + GlobImport(Path, ast::NodeId), + ImportList(Path, ~[ViewListIdent], ast::NodeId) +} + +impl Clean for ast::view_path { + fn clean(&self) -> ViewPath { + match self.node { + ast::view_path_simple(ref i, ref p, ref id) => SimpleImport(i.clean(), p.clean(), *id), + ast::view_path_glob(ref p, ref id) => GlobImport(p.clean(), *id), + ast::view_path_list(ref p, ref pl, ref id) => ImportList(p.clean(), pl.clean(), *id), + } + } +} + +pub type ViewListIdent = ~str; + +impl Clean for ast::path_list_ident { + fn clean(&self) -> ViewListIdent { + self.node.name.clean() + } +} + +// Utilities + +trait ToSource { + fn to_src(&self) -> ~str; +} + +impl ToSource for syntax::codemap::Span { + fn to_src(&self) -> ~str { + debug!("converting span %s to snippet", self.clean()); + let cm = local_data::get(super::ctxtkey, |x| x.unwrap().clone()).sess.codemap.clone(); + let sn = match cm.span_to_snippet(*self) { + Some(x) => x, + None => ~"" + }; + debug!("got snippet %s", sn); + sn + } +} + +fn lit_to_str(lit: &ast::lit) -> ~str { + match lit.node { + ast::lit_str(st) => st.to_owned(), + ast::lit_char(c) => ~"'" + std::char::from_u32(c).unwrap().to_str() + "'", + ast::lit_int(i, _t) => i.to_str(), + ast::lit_uint(u, _t) => u.to_str(), + ast::lit_int_unsuffixed(i) => i.to_str(), + ast::lit_float(f, _t) => f.to_str(), + ast::lit_float_unsuffixed(f) => f.to_str(), + ast::lit_bool(b) => b.to_str(), + ast::lit_nil => ~"", + } +} + +fn name_from_pat(p: &ast::Pat) -> ~str { + use syntax::ast::*; + match p.node { + PatWild => ~"_", + PatIdent(_, ref p, _) => path_to_str(p), + PatEnum(ref p, _) => path_to_str(p), + PatStruct(*) => fail!("tried to get argument name from pat_struct, \ + which is not allowed in function arguments"), + PatTup(*) => ~"(tuple arg NYI)", + PatBox(p) => name_from_pat(p), + PatUniq(p) => name_from_pat(p), + PatRegion(p) => name_from_pat(p), + PatLit(*) => fail!("tried to get argument name from pat_lit, \ + which is not allowed in function arguments"), + PatRange(*) => fail!("tried to get argument name from pat_range, \ + which is not allowed in function arguments"), + PatVec(*) => fail!("tried to get argument name from pat_vec, \ + which is not allowed in function arguments") + } +} + +fn remove_comment_tags(s: &str) -> ~str { + if s.starts_with("/") { + match s.slice(0,3) { + &"///" => return s.slice(3, s.len()).trim().to_owned(), + &"/**" | &"/*!" => return s.slice(3, s.len() - 2).trim().to_owned(), + _ => return s.trim().to_owned() + } + } else { + return s.to_owned(); + } +} + +/// Given a Type, resolve it using the def_map +fn resolve_type(t: &Type) -> Type { + use syntax::ast::*; + + let (path, tpbs, id) = match t { + &Unresolved(ref path, ref tbps, id) => (path, tbps, id), + _ => return (*t).clone(), + }; + + let dm = local_data::get(super::ctxtkey, |x| *x.unwrap()).tycx.def_map; + debug!("searching for %? in defmap", id); + let d = match dm.find(&id) { + Some(k) => k, + None => { + let ctxt = local_data::get(super::ctxtkey, |x| *x.unwrap()); + debug!("could not find %? in defmap (`%s`)", id, + syntax::ast_map::node_id_to_str(ctxt.tycx.items, id, ctxt.sess.intr())); + fail!("Unexpected failure: unresolved id not in defmap (this is a bug!)") + } + }; + + let def_id = match *d { + DefFn(i, _) => i, + DefSelf(i) | DefSelfTy(i) => return Self(i), + DefTy(i) => i, + DefTrait(i) => { + debug!("saw DefTrait in def_to_id"); + i + }, + DefPrimTy(p) => match p { + ty_str => return String, + ty_bool => return Bool, + _ => return Primitive(p) + }, + DefTyParam(i, _) => return Generic(i.node), + DefStruct(i) => i, + DefTyParamBinder(i) => { + debug!("found a typaram_binder, what is it? %d", i); + return TyParamBinder(i); + }, + x => fail!("resolved type maps to a weird def %?", x), + }; + + if def_id.crate != ast::CRATE_NODE_ID { + use rustc::metadata::decoder::*; + + let sess = local_data::get(super::ctxtkey, |x| *x.unwrap()).sess; + let cratedata = ::rustc::metadata::cstore::get_crate_data(sess.cstore, def_id.crate); + let doc = lookup_item(def_id.node, cratedata.data); + let path = syntax::ast_map::path_to_str_with_sep(item_path(doc), "::", sess.intr()); + let ty = match def_like_to_def(item_to_def_like(doc, def_id, def_id.crate)) { + DefFn(*) => ~"fn", + DefTy(*) => ~"enum", + DefTrait(*) => ~"trait", + DefPrimTy(p) => match p { + ty_str => ~"str", + ty_bool => ~"bool", + ty_int(t) => match t.to_str() { + ~"" => ~"i", + s => s + }, + ty_uint(t) => t.to_str(), + ty_float(t) => t.to_str(), + ty_char => ~"char", + }, + DefTyParam(*) => ~"generic", + DefStruct(*) => ~"struct", + DefTyParamBinder(*) => ~"typaram_binder", + x => fail!("resolved external maps to a weird def %?", x), + }; + let cname = cratedata.name.to_owned(); + External(cname + "::" + path, ty) + } else { + ResolvedPath {path: path.clone(), typarams: tpbs.clone(), id: def_id.node} + } +} diff --git a/src/librustdoc/config.rs b/src/librustdoc/config.rs deleted file mode 100644 index 71ece178807..00000000000 --- a/src/librustdoc/config.rs +++ /dev/null @@ -1,373 +0,0 @@ -// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - - -use std::cell::Cell; -use std::os; -use std::result::Result; -use std::result; -use std::run::ProcessOutput; -use std::run; -use std::vec; -use extra::getopts; - -/// The type of document to output -#[deriving(Clone, Eq)] -pub enum OutputFormat { - /// Markdown - Markdown, - /// HTML, via markdown and pandoc - PandocHtml -} - -/// How to organize the output -#[deriving(Clone, Eq)] -pub enum OutputStyle { - /// All in a single document - DocPerCrate, - /// Each module in its own document - DocPerMod -} - -/// The configuration for a rustdoc session -#[deriving(Clone)] -pub struct Config { - input_crate: Path, - output_dir: Path, - output_format: OutputFormat, - output_style: OutputStyle, - pandoc_cmd: Option<~str> -} - -fn opt_output_dir() -> ~str { ~"output-dir" } -fn opt_output_format() -> ~str { ~"output-format" } -fn opt_output_style() -> ~str { ~"output-style" } -fn opt_pandoc_cmd() -> ~str { ~"pandoc-cmd" } -fn opt_help() -> ~str { ~"h" } - -fn opts() -> ~[(getopts::Opt, ~str)] { - ~[ - (getopts::optopt(opt_output_dir()), - ~"--output-dir Put documents here (default: .)"), - (getopts::optopt(opt_output_format()), - ~"--output-format 'markdown' or 'html' (default)"), - (getopts::optopt(opt_output_style()), - ~"--output-style 'doc-per-crate' or 'doc-per-mod' (default)"), - (getopts::optopt(opt_pandoc_cmd()), - ~"--pandoc-cmd Command for running pandoc"), - (getopts::optflag(opt_help()), - ~"-h, --help Print help") - ] -} - -pub fn usage() { - use std::io::println; - - println("Usage: rustdoc [options] \n"); - println("Options:\n"); - let r = opts(); - for opt in r.iter() { - printfln!(" %s", opt.second()); - } - println(""); -} - -pub fn default_config(input_crate: &Path) -> Config { - Config { - input_crate: (*input_crate).clone(), - output_dir: Path("."), - output_format: PandocHtml, - output_style: DocPerMod, - pandoc_cmd: None - } -} - -type Process = ~fn((&str), (&[~str])) -> ProcessOutput; - -pub fn mock_process_output(_prog: &str, _args: &[~str]) -> ProcessOutput { - ProcessOutput { - status: 0, - output: ~[], - error: ~[] - } -} - -pub fn process_output(prog: &str, args: &[~str]) -> ProcessOutput { - run::process_output(prog, args) -} - -pub fn parse_config(args: &[~str]) -> Result { - parse_config_(args, process_output) -} - -pub fn parse_config_( - args: &[~str], - process_output: Process -) -> Result { - let args = args.tail(); - let opts = vec::unzip(opts().move_iter()).first(); - match getopts::getopts(args, opts) { - Ok(matches) => { - if matches.free.len() == 1 { - let input_crate = Path(*matches.free.head()); - config_from_opts(&input_crate, &matches, process_output) - } else if matches.free.is_empty() { - Err(~"no crates specified") - } else { - Err(~"multiple crates specified") - } - } - Err(f) => { - Err(f.to_err_msg()) - } - } -} - -fn config_from_opts( - input_crate: &Path, - matches: &getopts::Matches, - process_output: Process -) -> Result { - - let config = default_config(input_crate); - let result = result::Ok(config); - let result = do result.and_then |config| { - let output_dir = matches.opt_str(opt_output_dir()); - let output_dir = output_dir.map_move(|s| Path(s)); - result::Ok(Config { - output_dir: output_dir.unwrap_or(config.output_dir.clone()), - .. config - }) - }; - let result = do result.and_then |config| { - let output_format = matches.opt_str(opt_output_format()); - do output_format.map_move_default(result::Ok(config.clone())) |output_format| { - do parse_output_format(output_format).and_then |output_format| { - result::Ok(Config { - output_format: output_format, - .. config.clone() - }) - } - } - }; - let result = do result.and_then |config| { - let output_style = - matches.opt_str(opt_output_style()); - do output_style.map_move_default(result::Ok(config.clone())) |output_style| { - do parse_output_style(output_style).and_then |output_style| { - result::Ok(Config { - output_style: output_style, - .. config.clone() - }) - } - } - }; - let process_output = Cell::new(process_output); - let result = do result.and_then |config| { - let pandoc_cmd = matches.opt_str(opt_pandoc_cmd()); - let pandoc_cmd = maybe_find_pandoc( - &config, pandoc_cmd, process_output.take()); - do pandoc_cmd.and_then |pandoc_cmd| { - result::Ok(Config { - pandoc_cmd: pandoc_cmd, - .. config.clone() - }) - } - }; - return result; -} - -fn parse_output_format(output_format: &str) -> Result { - match output_format.to_str() { - ~"markdown" => result::Ok(Markdown), - ~"html" => result::Ok(PandocHtml), - _ => result::Err(fmt!("unknown output format '%s'", output_format)) - } -} - -fn parse_output_style(output_style: &str) -> Result { - match output_style.to_str() { - ~"doc-per-crate" => result::Ok(DocPerCrate), - ~"doc-per-mod" => result::Ok(DocPerMod), - _ => result::Err(fmt!("unknown output style '%s'", output_style)) - } -} - -pub fn maybe_find_pandoc( - config: &Config, - maybe_pandoc_cmd: Option<~str>, - process_output: Process -) -> Result, ~str> { - if config.output_format != PandocHtml { - return result::Ok(maybe_pandoc_cmd); - } - - let possible_pandocs = match maybe_pandoc_cmd { - Some(pandoc_cmd) => ~[pandoc_cmd], - None => { - ~[~"pandoc"] + match os::homedir() { - Some(dir) => { - ~[dir.push_rel(&Path(".cabal/bin/pandoc")).to_str()] - } - None => ~[] - } - } - }; - - let pandoc = do possible_pandocs.iter().find |&pandoc| { - let output = process_output(*pandoc, [~"--version"]); - debug!("testing pandoc cmd %s: %?", *pandoc, output); - output.status == 0 - }; - - match pandoc { - Some(x) => Ok(Some((*x).clone())), // ugly, shouldn't be doubly wrapped - None => Err(~"couldn't find pandoc") - } -} - -#[cfg(test)] -mod test { - - use config::*; - use std::result; - use std::run::ProcessOutput; - - fn parse_config(args: &[~str]) -> Result { - parse_config_(args, mock_process_output) - } - - #[test] - fn should_find_pandoc() { - let config = Config { - output_format: PandocHtml, - .. default_config(&Path("test")) - }; - let mock_process_output: ~fn(&str, &[~str]) -> ProcessOutput = |_, _| { - ProcessOutput { status: 0, output: "pandoc 1.8.2.1".as_bytes().to_owned(), error: ~[] } - }; - let result = maybe_find_pandoc(&config, None, mock_process_output); - assert!(result == result::Ok(Some(~"pandoc"))); - } - - #[test] - fn should_error_with_no_pandoc() { - let config = Config { - output_format: PandocHtml, - .. default_config(&Path("test")) - }; - let mock_process_output: ~fn(&str, &[~str]) -> ProcessOutput = |_, _| { - ProcessOutput { status: 1, output: ~[], error: ~[] } - }; - let result = maybe_find_pandoc(&config, None, mock_process_output); - assert!(result == result::Err(~"couldn't find pandoc")); - } - - #[test] - fn should_error_with_no_crates() { - let config = parse_config([~"rustdoc"]); - assert!(config.unwrap_err() == ~"no crates specified"); - } - - #[test] - fn should_error_with_multiple_crates() { - let config = - parse_config([~"rustdoc", ~"crate1.rc", ~"crate2.rc"]); - assert!(config.unwrap_err() == ~"multiple crates specified"); - } - - #[test] - fn should_set_output_dir_to_cwd_if_not_provided() { - let config = parse_config([~"rustdoc", ~"crate.rc"]); - assert!(config.unwrap().output_dir == Path(".")); - } - - #[test] - fn should_set_output_dir_if_provided() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-dir", ~"snuggles" - ]); - assert!(config.unwrap().output_dir == Path("snuggles")); - } - - #[test] - fn should_set_output_format_to_pandoc_html_if_not_provided() { - let config = parse_config([~"rustdoc", ~"crate.rc"]); - assert!(config.unwrap().output_format == PandocHtml); - } - - #[test] - fn should_set_output_format_to_markdown_if_requested() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-format", ~"markdown" - ]); - assert!(config.unwrap().output_format == Markdown); - } - - #[test] - fn should_set_output_format_to_pandoc_html_if_requested() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-format", ~"html" - ]); - assert!(config.unwrap().output_format == PandocHtml); - } - - #[test] - fn should_error_on_bogus_format() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-format", ~"bogus" - ]); - assert!(config.unwrap_err() == ~"unknown output format 'bogus'"); - } - - #[test] - fn should_set_output_style_to_doc_per_mod_by_default() { - let config = parse_config([~"rustdoc", ~"crate.rc"]); - assert!(config.unwrap().output_style == DocPerMod); - } - - #[test] - fn should_set_output_style_to_one_doc_if_requested() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-style", ~"doc-per-crate" - ]); - assert!(config.unwrap().output_style == DocPerCrate); - } - - #[test] - fn should_set_output_style_to_doc_per_mod_if_requested() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-style", ~"doc-per-mod" - ]); - assert!(config.unwrap().output_style == DocPerMod); - } - - #[test] - fn should_error_on_bogus_output_style() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--output-style", ~"bogus" - ]); - assert!(config.unwrap_err() == ~"unknown output style 'bogus'"); - } - - #[test] - fn should_set_pandoc_command_if_requested() { - let config = parse_config([ - ~"rustdoc", ~"crate.rc", ~"--pandoc-cmd", ~"panda-bear-doc" - ]); - assert!(config.unwrap().pandoc_cmd == Some(~"panda-bear-doc")); - } - - #[test] - fn should_set_pandoc_command_when_using_pandoc() { - let config = parse_config([~"rustdoc", ~"crate.rc"]); - assert!(config.unwrap().pandoc_cmd == Some(~"pandoc")); - } -} diff --git a/src/librustdoc/core.rs b/src/librustdoc/core.rs new file mode 100644 index 00000000000..9fb5e8c04c1 --- /dev/null +++ b/src/librustdoc/core.rs @@ -0,0 +1,78 @@ +// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +use rustc; +use rustc::{driver, middle}; + +use syntax; +use syntax::parse; +use syntax::ast; + +use std::os; +use std::local_data; + +use visit_ast::RustdocVisitor; +use clean; +use clean::Clean; + +pub struct DocContext { + crate: @ast::Crate, + tycx: middle::ty::ctxt, + sess: driver::session::Session +} + +/// Parses, resolves, and typechecks the given crate +fn get_ast_and_resolve(cpath: &Path, libs: ~[Path]) -> DocContext { + use syntax::codemap::dummy_spanned; + use rustc::driver::driver::*; + + let parsesess = parse::new_parse_sess(None); + let input = file_input(cpath.clone()); + + let sessopts = @driver::session::options { + binary: @"rustdoc", + maybe_sysroot: Some(@os::self_exe_path().unwrap().pop()), + addl_lib_search_paths: @mut libs, + .. (*rustc::driver::session::basic_options()).clone() + }; + + + let diagnostic_handler = syntax::diagnostic::mk_handler(None); + let span_diagnostic_handler = + syntax::diagnostic::mk_span_handler(diagnostic_handler, parsesess.cm); + + let sess = driver::driver::build_session_(sessopts, parsesess.cm, + syntax::diagnostic::emit, + span_diagnostic_handler); + + let mut cfg = build_configuration(sess); + cfg.push(@dummy_spanned(ast::MetaWord(@"stage2"))); + + let mut crate = phase_1_parse_input(sess, cfg.clone(), &input); + crate = phase_2_configure_and_expand(sess, cfg, crate); + let analysis = phase_3_run_analysis_passes(sess, crate); + + debug!("crate: %?", crate); + DocContext { crate: crate, tycx: analysis.ty_cx, sess: sess } +} + +pub fn run_core (libs: ~[Path], path: &Path) -> clean::Crate { + let ctxt = @get_ast_and_resolve(path, libs); + debug!("defmap:"); + for (k, v) in ctxt.tycx.def_map.iter() { + debug!("%?: %?", k, v); + } + local_data::set(super::ctxtkey, ctxt); + + let v = @mut RustdocVisitor::new(); + v.visit(ctxt.crate); + + v.clean() +} diff --git a/src/librustdoc/demo.rs b/src/librustdoc/demo.rs deleted file mode 100644 index 23c55488332..00000000000 --- a/src/librustdoc/demo.rs +++ /dev/null @@ -1,199 +0,0 @@ -// Copyright 2012 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -// no-reformat - -/*! - * A demonstration module - * - * Contains documentation in various forms that rustdoc understands, - * for testing purposes. It doesn't surve any functional - * purpose. This here, for instance, is just some filler text. - * - * FIXME (#3731): It would be nice if we could run some automated - * tests on this file - */ - - -/// The base price of a muffin on a non-holiday -static PRICE_OF_A_MUFFIN: float = 70f; - -struct WaitPerson { - hair_color: ~str -} - -/// The type of things that produce omnomnom -enum OmNomNomy { - /// Delicious sugar cookies - Cookie, - /// It's pizza - PizzaPie(~[uint]) -} - -fn take_my_order_please( - _waitperson: WaitPerson, - _order: ~[OmNomNomy] -) -> uint { - - /*! - * OMG would you take my order already? - * - * # Arguments - * - * * _waitperson - The waitperson that you want to bother - * * _order - The order vector. It should be filled with food - * - * # Return - * - * The price of the order, including tax - * - * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec - * molestie nisl. Duis massa risus, pharetra a scelerisque a, - * molestie eu velit. Donec mattis ligula at ante imperdiet ut - * dapibus mauris malesuada. - * - * Sed gravida nisi a metus elementum sit amet hendrerit dolor - * bibendum. Aenean sit amet neque massa, sed tempus tortor. Sed ut - * lobortis enim. Proin a mauris quis nunc fermentum ultrices eget a - * erat. Mauris in lectus vitae metus sodales auctor. Morbi nunc - * quam, ultricies at venenatis non, pellentesque ac dui. - * - * # Failure - * - * This function is full of fail - */ - - fail!(); -} - -mod fortress_of_solitude { - /*! - * Superman's vacation home - * - * The fortress of solitude is located in the Arctic and it is - * cold. What you may not know about the fortress of solitude - * though is that it contains two separate bowling alleys. One of - * them features bumper-bowling and is kind of lame. - * - * Really, it's pretty cool. - */ - -} - -mod blade_runner { - /*! - * Blade Runner is probably the best movie ever - * - * I like that in the world of Blade Runner it is always - * raining, and that it's always night time. And Aliens - * was also a really good movie. - * - * Alien 3 was crap though. - */ -} - -/** - * Bored - * - * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec - * molestie nisl. Duis massa risus, pharetra a scelerisque a, - * molestie eu velit. Donec mattis ligula at ante imperdiet ut - * dapibus mauris malesuada. Sed gravida nisi a metus elementum sit - * amet hendrerit dolor bibendum. Aenean sit amet neque massa, sed - * tempus tortor. Sed ut lobortis enim. Proin a mauris quis nunc - * fermentum ultrices eget a erat. Mauris in lectus vitae metus - * sodales auctor. Morbi nunc quam, ultricies at venenatis non, - * pellentesque ac dui. - * - * Quisque vitae est id eros placerat laoreet sit amet eu - * nisi. Curabitur suscipit neque porttitor est euismod - * lacinia. Curabitur non quam vitae ipsum adipiscing - * condimentum. Mauris ut ante eget metus sollicitudin - * blandit. Aliquam erat volutpat. Morbi sed nisl mauris. Nulla - * facilisi. Phasellus at mollis ipsum. Maecenas sed convallis - * sapien. Nullam in ligula turpis. Pellentesque a neque augue. Sed - * eget ante feugiat tortor congue auctor ac quis ante. Proin - * condimentum lacinia tincidunt. - */ -struct Bored { - bored: bool, -} - -impl Drop for Bored { - fn drop(&mut self) { } -} - -/** - * The Shunned House - * - * From even the greatest of horrors irony is seldom absent. Sometimes it - * enters directly into the composition of the events, while sometimes it - * relates only to their fortuitous position among persons and - * places. The latter sort is splendidly exemplified by a case in the - * ancient city of Providence, where in the late forties Edgar Allan Poe - * used to sojourn often during his unsuccessful wooing of the gifted - * poetess, Mrs. Whitman. Poe generally stopped at the Mansion House in - * Benefit Street--the renamed Golden Ball Inn whose roof has sheltered - * Washington, Jefferson, and Lafayette--and his favorite walk led - * northward along the same street to Mrs. Whitman's home and the - * neighboring hillside churchyard of St. John's, whose hidden expanse of - * Eighteenth Century gravestones had for him a peculiar fascination. - */ -trait TheShunnedHouse { - /** - * Now the irony is this. In this walk, so many times repeated, the - * world's greatest master of the terrible and the bizarre was - * obliged to pass a particular house on the eastern side of the - * street; a dingy, antiquated structure perched on the abruptly - * rising side hill, with a great unkempt yard dating from a time - * when the region was partly open country. It does not appear that - * he ever wrote or spoke of it, nor is there any evidence that he - * even noticed it. And yet that house, to the two persons in - * possession of certain information, equals or outranks in horror - * the wildest fantasy of the genius who so often passed it - * unknowingly, and stands starkly leering as a symbol of all that is - * unutterably hideous. - * - * # Arguments - * - * * unkempt_yard - A yard dating from a time when the region was partly - * open country - */ - fn dingy_house(&self, unkempt_yard: int); - - /** - * The house was--and for that matter still is--of a kind to attract - * the attention of the curious. Originally a farm or semi-farm - * building, it followed the average New England colonial lines of - * the middle Eighteenth Century--the prosperous peaked-roof sort, - * with two stories and dormerless attic, and with the Georgian - * doorway and interior panelling dictated by the progress of taste - * at that time. It faced south, with one gable end buried to the - * lower windows in the eastward rising hill, and the other exposed - * to the foundations toward the street. Its construction, over a - * century and a half ago, had followed the grading and straightening - * of the road in that especial vicinity; for Benefit Street--at - * first called Back Street--was laid out as a lane winding amongst - * the graveyards of the first settlers, and straightened only when - * the removal of the bodies to the North Burial Ground made it - * decently possible to cut through the old family plots. - */ - fn construct(&self) -> bool; -} - -/// Whatever -impl TheShunnedHouse for OmNomNomy { - fn dingy_house(&self, _unkempt_yard: int) { - } - - fn construct(&self) -> bool { - fail!(); - } -} diff --git a/src/librustdoc/desc_to_brief_pass.rs b/src/librustdoc/desc_to_brief_pass.rs deleted file mode 100644 index 9f8041712ea..00000000000 --- a/src/librustdoc/desc_to_brief_pass.rs +++ /dev/null @@ -1,288 +0,0 @@ -// Copyright 2012 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -/*! -Pulls a brief description out of a long description. - -If the first paragraph of a long description is short enough then it -is interpreted as the brief description. -*/ - - -use astsrv; -use doc::ItemUtils; -use doc; -use fold::Fold; -use fold; -use pass::Pass; - -use std::util; - -pub fn mk_pass() -> Pass { - Pass { - name: ~"desc_to_brief", - f: run - } -} - -pub fn run( - _srv: astsrv::Srv, - doc: doc::Doc -) -> doc::Doc { - let fold = Fold { - fold_item: fold_item, - fold_trait: fold_trait, - fold_impl: fold_impl, - .. fold::default_any_fold(()) - }; - (fold.fold_doc)(&fold, doc) -} - -fn fold_item(fold: &fold::Fold<()>, doc: doc::ItemDoc) -> doc::ItemDoc { - let doc = fold::default_seq_fold_item(fold, doc); - - doc::ItemDoc { - brief: extract(doc.desc.clone()), - .. doc - } -} - -fn fold_trait(fold: &fold::Fold<()>, doc: doc::TraitDoc) -> doc::TraitDoc { - let doc =fold::default_seq_fold_trait(fold, doc); - - doc::TraitDoc { - methods: doc.methods.map(|doc| doc::MethodDoc { - brief: extract(doc.desc.clone()), - .. (*doc).clone() - }), - .. doc - } -} - -fn fold_impl(fold: &fold::Fold<()>, doc: doc::ImplDoc) -> doc::ImplDoc { - let doc =fold::default_seq_fold_impl(fold, doc); - - doc::ImplDoc { - methods: doc.methods.map(|doc| doc::MethodDoc { - brief: extract(doc.desc.clone()), - .. (*doc).clone() - }), - .. doc - } -} - -pub fn extract(desc: Option<~str>) -> Option<~str> { - if desc.is_none() { - return None - } - - parse_desc(desc.clone().unwrap()) -} - -fn parse_desc(desc: ~str) -> Option<~str> { - static MAX_BRIEF_LEN: uint = 120u; - - match first_sentence(desc.clone()) { - Some(first_sentence) => { - if first_sentence.len() <= MAX_BRIEF_LEN { - Some(first_sentence) - } else { - None - } - } - None => None - } -} - -fn first_sentence(s: ~str) -> Option<~str> { - let paras = paragraphs(s); - if !paras.is_empty() { - let first_para = paras.head(); - Some(first_sentence_(*first_para).replace("\n", " ")) - } else { - None - } -} - -fn first_sentence_(s: &str) -> ~str { - let mut dotcount = 0; - // The index of the character following a single dot. This allows - // Things like [0..1) to appear in the brief description - let idx = s.find(|ch: char| { - if ch == '.' { - dotcount += 1; - false - } else if dotcount == 1 { - true - } else { - dotcount = 0; - false - } - }); - match idx { - Some(idx) if idx > 2u => s.slice(0, idx - 1).to_owned(), - _ => { - if s.ends_with(".") { - s.to_owned() - } else { - s.to_owned() - } - } - } -} - -pub fn paragraphs(s: &str) -> ~[~str] { - let mut whitespace_lines = 0; - let mut accum = ~""; - let mut paras = do s.any_line_iter().fold(~[]) |paras, line| { - let mut res = paras; - - if line.is_whitespace() { - whitespace_lines += 1; - } else { - if whitespace_lines > 0 { - if !accum.is_empty() { - let v = util::replace(&mut accum, ~""); - res.push(v); - } - } - - whitespace_lines = 0; - - accum = if accum.is_empty() { - line.to_owned() - } else { - fmt!("%s\n%s", accum, line) - } - } - - res - }; - - if !accum.is_empty() { paras.push(accum); } - paras -} - -#[cfg(test)] -mod test { - - use astsrv; - use attr_pass; - use super::{extract, paragraphs, run}; - use doc; - use extract; - - fn mk_doc(source: ~str) -> doc::Doc { - do astsrv::from_str(source.clone()) |srv| { - let doc = extract::from_srv(srv.clone(), ~""); - let doc = (attr_pass::mk_pass().f)(srv.clone(), doc); - run(srv.clone(), doc) - } - } - - #[test] - fn should_promote_desc() { - let doc = mk_doc(~"#[doc = \"desc\"] mod m { }"); - // hidden __std_macros module at the start. - assert_eq!(doc.cratemod().mods()[1].brief(), Some(~"desc")); - } - - #[test] - fn should_promote_trait_method_desc() { - let doc = mk_doc(~"trait i { #[doc = \"desc\"] fn a(); }"); - assert!(doc.cratemod().traits()[0].methods[0].brief == - Some(~"desc")); - } - - #[test] - fn should_promote_impl_method_desc() { - let doc = mk_doc( - ~"impl int { #[doc = \"desc\"] fn a() { } }"); - assert!(doc.cratemod().impls()[0].methods[0].brief == Some(~"desc")); - } - - #[test] - fn test_paragraphs_1() { - let paras = paragraphs("1\n\n2"); - assert_eq!(paras, ~[~"1", ~"2"]); - } - - #[test] - fn test_paragraphs_2() { - let paras = paragraphs("\n\n1\n1\n\n2\n\n"); - assert_eq!(paras, ~[~"1\n1", ~"2"]); - } - - #[test] - fn should_promote_short_descs() { - let desc = Some(~"desc"); - let brief = extract(desc.clone()); - assert_eq!(brief, desc); - } - - #[test] - fn should_not_promote_long_descs() { - let desc = Some(~"Warkworth Castle is a ruined medieval building -in the town of the same name in the English county of Northumberland, -and the town and castle occupy a loop of the River Coquet, less than a mile -from England's north-east coast. When the castle was founded is uncertain, -but traditionally its construction has been ascribed to Prince Henry of -Scotland in the mid 12th century, although it may have been built by -King Henry II of England when he took control of England'snorthern -counties."); - let brief = extract(desc); - assert_eq!(brief, None); - } - - #[test] - fn should_promote_first_sentence() { - let desc = Some(~"Warkworth Castle is a ruined medieval building -in the town. of the same name in the English county of Northumberland, -and the town and castle occupy a loop of the River Coquet, less than a mile -from England's north-east coast. When the castle was founded is uncertain, -but traditionally its construction has been ascribed to Prince Henry of -Scotland in the mid 12th century, although it may have been built by -King Henry II of England when he took control of England'snorthern -counties."); - let brief = extract(desc); - assert!(brief == Some( - ~"Warkworth Castle is a ruined medieval building in the town")); - } - - #[test] - fn should_not_consider_double_period_to_end_sentence() { - let desc = Some(~"Warkworth..Castle is a ruined medieval building -in the town. of the same name in the English county of Northumberland, -and the town and castle occupy a loop of the River Coquet, less than a mile -from England's north-east coast. When the castle was founded is uncertain, -but traditionally its construction has been ascribed to Prince Henry of -Scotland in the mid 12th century, although it may have been built by -King Henry II of England when he took control of England'snorthern -counties."); - let brief = extract(desc); - assert!(brief == Some( - ~"Warkworth..Castle is a ruined medieval building in the town")); - } - - #[test] - fn should_not_consider_triple_period_to_end_sentence() { - let desc = Some(~"Warkworth... Castle is a ruined medieval building -in the town. of the same name in the English county of Northumberland, -and the town and castle occupy a loop of the River Coquet, less than a mile -from England's north-east coast. When the castle was founded is uncertain, -but traditionally its construction has been ascribed to Prince Henry of -Scotland in the mid 12th century, although it may have been built by -King Henry II of England when he took control of England'snorthern -counties."); - let brief = extract(desc); - assert!(brief == Some( - ~"Warkworth... Castle is a ruined medieval building in the town")); - } -} diff --git a/src/librustdoc/doc.rs b/src/librustdoc/doc.rs deleted file mode 100644 index aba7ea1f0d7..00000000000 --- a/src/librustdoc/doc.rs +++ /dev/null @@ -1,393 +0,0 @@ -// Copyright 2012 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -//! The document model - - -use doc; - -pub type AstId = int; - -#[deriving(Clone, Eq)] -pub struct Doc { - pages: ~[Page] -} - -#[deriving(Clone, Eq)] -pub enum Page { - CratePage(CrateDoc), - ItemPage(ItemTag) -} - -#[deriving(Clone, Eq)] -pub enum Implementation { - Required, - Provided, -} - -/** - * Most rustdocs can be parsed into 'sections' according to their markdown - * headers - */ -#[deriving(Clone, Eq)] -pub struct Section { - header: ~str, - body: ~str -} - -// FIXME (#2596): We currently give topmod the name of the crate. There -// would probably be fewer special cases if the crate had its own name -// and topmod's name was the empty string. -#[deriving(Clone, Eq)] -pub struct CrateDoc { - topmod: ModDoc -} - -#[deriving(Clone, Eq)] -pub enum ItemTag { - ModTag(ModDoc), - NmodTag(NmodDoc), - StaticTag(StaticDoc), - FnTag(FnDoc), - EnumTag(EnumDoc), - TraitTag(TraitDoc), - ImplTag(ImplDoc), - TyTag(TyDoc), - StructTag(StructDoc) -} - -#[deriving(Clone, Eq)] -pub struct ItemDoc { - id: AstId, - name: ~str, - path: ~[~str], - brief: Option<~str>, - desc: Option<~str>, - sections: ~[Section], - // Indicates that this node is a reexport of a different item - reexport: bool -} - -#[deriving(Clone, Eq)] -pub struct SimpleItemDoc { - item: ItemDoc, - sig: Option<~str> -} - -#[deriving(Clone, Eq)] -pub struct ModDoc { - item: ItemDoc, - items: ~[ItemTag], - index: Option -} - -#[deriving(Clone, Eq)] -pub struct NmodDoc { - item: ItemDoc, - fns: ~[FnDoc], - index: Option -} - -pub type StaticDoc = SimpleItemDoc; - -pub type FnDoc = SimpleItemDoc; - -#[deriving(Clone, Eq)] -pub struct EnumDoc { - item: ItemDoc, - variants: ~[VariantDoc] -} - -#[deriving(Clone, Eq)] -pub struct VariantDoc { - name: ~str, - desc: Option<~str>, - sig: Option<~str> -} - -#[deriving(Clone, Eq)] -pub struct TraitDoc { - item: ItemDoc, - methods: ~[MethodDoc] -} - -#[deriving(Clone, Eq)] -pub struct MethodDoc { - name: ~str, - brief: Option<~str>, - desc: Option<~str>, - sections: ~[Section], - sig: Option<~str>, - implementation: Implementation, -} - -#[deriving(Clone, Eq)] -pub struct ImplDoc { - item: ItemDoc, - bounds_str: Option<~str>, - trait_types: ~[~str], - self_ty: Option<~str>, - methods: ~[MethodDoc] -} - -pub type TyDoc = SimpleItemDoc; - -#[deriving(Clone, Eq)] -pub struct StructDoc { - item: ItemDoc, - fields: ~[~str], - sig: Option<~str> -} - -#[deriving(Clone, Eq)] -pub struct Index { - entries: ~[IndexEntry] -} - -/** - * A single entry in an index - * - * Fields: - * - * * kind - The type of thing being indexed, e.g. 'Module' - * * name - The name of the thing - * * brief - The brief description - * * link - A format-specific string representing the link target - */ -#[deriving(Clone, Eq)] -pub struct IndexEntry { - kind: ~str, - name: ~str, - brief: Option<~str>, - link: ~str -} - -impl Doc { - pub fn CrateDoc(&self) -> CrateDoc { - self.pages.iter().fold(None, |_m, page| { - match (*page).clone() { - doc::CratePage(doc) => Some(doc), - _ => None - } - }).unwrap() - } - - pub fn cratemod(&self) -> ModDoc { - self.CrateDoc().topmod.clone() - } -} - -macro_rules! filt_mapper { - ($vec:expr, $pat:pat) => { - do ($vec).iter().filter_map |thing| { - match thing { - &$pat => Some((*x).clone()), - _ => None - } - }.collect() - } -} - -macro_rules! md { - ($id:ident) => { - filt_mapper!(self.items, $id(ref x)) - } -} -/// Some helper methods on ModDoc, mostly for testing -impl ModDoc { - pub fn mods(&self) -> ~[ModDoc] { - md!(ModTag) - } - - pub fn nmods(&self) -> ~[NmodDoc] { - md!(NmodTag) - } - - pub fn fns(&self) -> ~[FnDoc] { - md!(FnTag) - } - - pub fn statics(&self) -> ~[StaticDoc] { - md!(StaticTag) - } - - pub fn enums(&self) -> ~[EnumDoc] { - md!(EnumTag) - } - - pub fn traits(&self) -> ~[TraitDoc] { - md!(TraitTag) - } - - pub fn impls(&self) -> ~[ImplDoc] { - md!(ImplTag) - } - - pub fn types(&self) -> ~[TyDoc] { - md!(TyTag) - } - - pub fn structs(&self) -> ~[StructDoc] { - md!(StructTag) - } -} - -macro_rules! pu { - ($id:ident) => { - filt_mapper!(*self, ItemPage($id(ref x))) - } -} - -pub trait PageUtils { - fn mods(&self) -> ~[ModDoc]; - fn nmods(&self) -> ~[NmodDoc]; - fn fns(&self) -> ~[FnDoc]; - fn statics(&self) -> ~[StaticDoc]; - fn enums(&self) -> ~[EnumDoc]; - fn traits(&self) -> ~[TraitDoc]; - fn impls(&self) -> ~[ImplDoc]; - fn types(&self) -> ~[TyDoc]; -} - -impl PageUtils for ~[Page] { - - fn mods(&self) -> ~[ModDoc] { - pu!(ModTag) - } - - fn nmods(&self) -> ~[NmodDoc] { - pu!(NmodTag) - } - - fn fns(&self) -> ~[FnDoc] { - pu!(FnTag) - } - - fn statics(&self) -> ~[StaticDoc] { - pu!(StaticTag) - } - - fn enums(&self) -> ~[EnumDoc] { - pu!(EnumTag) - } - - fn traits(&self) -> ~[TraitDoc] { - pu!(TraitTag) - } - - fn impls(&self) -> ~[ImplDoc] { - pu!(ImplTag) - } - - fn types(&self) -> ~[TyDoc] { - pu!(TyTag) - } -} - -pub trait Item { - fn item(&self) -> ItemDoc; -} - -impl Item for ItemTag { - fn item(&self) -> ItemDoc { - match self { - &doc::ModTag(ref doc) => doc.item.clone(), - &doc::NmodTag(ref doc) => doc.item.clone(), - &doc::FnTag(ref doc) => doc.item.clone(), - &doc::StaticTag(ref doc) => doc.item.clone(), - &doc::EnumTag(ref doc) => doc.item.clone(), - &doc::TraitTag(ref doc) => doc.item.clone(), - &doc::ImplTag(ref doc) => doc.item.clone(), - &doc::TyTag(ref doc) => doc.item.clone(), - &doc::StructTag(ref doc) => doc.item.clone(), - } - } -} - -impl Item for SimpleItemDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -impl Item for ModDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -impl Item for NmodDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -impl Item for EnumDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -impl Item for TraitDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -impl Item for ImplDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -impl Item for StructDoc { - fn item(&self) -> ItemDoc { - self.item.clone() - } -} - -pub trait ItemUtils { - fn id(&self) -> AstId; - /// FIXME #5898: This conflicts with - /// syntax::attr::AttrMetaMethods.name; This rustdoc seems to be on - /// the way out so I'm making this one look bad rather than the - /// new methods in attr. - fn name_(&self) -> ~str; - fn path(&self) -> ~[~str]; - fn brief(&self) -> Option<~str>; - fn desc(&self) -> Option<~str>; - fn sections(&self) -> ~[Section]; -} - -impl ItemUtils for A { - fn id(&self) -> AstId { - self.item().id - } - - fn name_(&self) -> ~str { - self.item().name.clone() - } - - fn path(&self) -> ~[~str] { - self.item().path.clone() - } - - fn brief(&self) -> Option<~str> { - self.item().brief.clone() - } - - fn desc(&self) -> Option<~str> { - self.item().desc.clone() - } - - fn sections(&self) -> ~[Section] { - self.item().sections.clone() - } -} diff --git a/src/librustdoc/doctree.rs b/src/librustdoc/doctree.rs new file mode 100644 index 00000000000..67722b1e177 --- /dev/null +++ b/src/librustdoc/doctree.rs @@ -0,0 +1,168 @@ +// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! This module is used to store stuff from Rust's AST in a more convenient +//! manner (and with prettier names) before cleaning. + +use syntax; +use syntax::codemap::Span; +use syntax::ast; +use syntax::ast::{Ident, NodeId}; + +pub struct Module { + name: Option, + attrs: ~[ast::Attribute], + where: Span, + structs: ~[Struct], + enums: ~[Enum], + fns: ~[Function], + mods: ~[Module], + id: NodeId, + typedefs: ~[Typedef], + statics: ~[Static], + traits: ~[Trait], + vis: ast::visibility, + impls: ~[Impl], + view_items: ~[ast::view_item], +} + +impl Module { + pub fn new(name: Option) -> Module { + Module { + name : name, + id: 0, + vis: ast::private, + where: syntax::codemap::dummy_sp(), + attrs : ~[], + structs : ~[], + enums : ~[], + fns : ~[], + mods : ~[], + typedefs : ~[], + statics : ~[], + traits : ~[], + impls : ~[], + view_items : ~[], + } + } +} + +#[deriving(ToStr, Clone, Encodable, Decodable)] +pub enum StructType { + /// A normal struct + Plain, + /// A tuple struct + Tuple, + /// A newtype struct (tuple struct with one element) + Newtype, + /// A unit struct + Unit +} + +pub enum TypeBound { + RegionBound, + TraitBound(ast::trait_ref) +} + +pub struct Struct { + vis: ast::visibility, + id: NodeId, + struct_type: StructType, + name: Ident, + generics: ast::Generics, + attrs: ~[ast::Attribute], + fields: ~[@ast::struct_field], + where: Span, +} + +pub struct Enum { + vis: ast::visibility, + variants: ~[Variant], + generics: ast::Generics, + attrs: ~[ast::Attribute], + id: NodeId, + where: Span, + name: Ident, +} + +pub struct Variant { + name: Ident, + attrs: ~[ast::Attribute], + kind: ast::variant_kind, + id: ast::NodeId, + vis: ast::visibility, + where: Span, +} + +pub struct Function { + decl: ast::fn_decl, + attrs: ~[ast::Attribute], + id: NodeId, + name: Ident, + vis: ast::visibility, + where: Span, + generics: ast::Generics, +} + +pub struct Typedef { + ty: ast::Ty, + gen: ast::Generics, + name: Ident, + id: ast::NodeId, + attrs: ~[ast::Attribute], + where: Span, + vis: ast::visibility, +} + +pub struct Static { + type_: ast::Ty, + mutability: ast::Mutability, + expr: @ast::Expr, + name: Ident, + attrs: ~[ast::Attribute], + vis: ast::visibility, + id: ast::NodeId, + where: Span, +} + +pub struct Trait { + name: Ident, + methods: ~[ast::trait_method], //should be TraitMethod + generics: ast::Generics, + parents: ~[ast::trait_ref], + attrs: ~[ast::Attribute], + id: ast::NodeId, + where: Span, + vis: ast::visibility, +} + +pub struct Impl { + generics: ast::Generics, + trait_: Option, + for_: ast::Ty, + methods: ~[@ast::method], + attrs: ~[ast::Attribute], + where: Span, + vis: ast::visibility, + id: ast::NodeId, +} + +pub fn struct_type_from_def(sd: &ast::struct_def) -> StructType { + if sd.ctor_id.is_some() { + // We are in a tuple-struct + match sd.fields.len() { + 0 => Unit, + 1 => Newtype, + _ => Tuple + } + } else { + Plain + } +} diff --git a/src/librustdoc/escape_pass.rs b/src/librustdoc/escape_pass.rs deleted file mode 100644 index 2f09e0a5ddc..00000000000 --- a/src/librustdoc/escape_pass.rs +++ /dev/null @@ -1,29 +0,0 @@ -// Copyright 2012 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -//! Escapes text sequences - -use pass::Pass; -use text_pass; - -pub fn mk_pass() -> Pass { - text_pass::mk_pass(~"escape", escape) -} - -fn escape(s: &str) -> ~str { - s.replace("\\", "\\\\") -} - -#[test] -fn should_escape_backslashes() { - let s = ~"\\n"; - let r = escape(s); - assert_eq!(r, ~"\\\\n"); -} diff --git a/src/librustdoc/extract.rs b/src/librustdoc/extract.rs deleted file mode 100644 index 2ab0530ccb3..00000000000 --- a/src/librustdoc/extract.rs +++ /dev/null @@ -1,414 +0,0 @@ -// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 or the MIT license -// , at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -//! Converts the Rust AST to the rustdoc document model - - -use astsrv; -use doc::ItemUtils; -use doc; - -use syntax::ast; -use syntax::parse::token::{ident_interner, ident_to_str}; -use syntax::parse::token; - -// Hack; rather than thread an interner through everywhere, rely on -// thread-local data -// Hack-Becomes-Feature: using thread-local-state everywhere... -pub fn to_str(id: ast::Ident) -> ~str { - /* bad */ ident_to_str(&id).to_owned() -} - -// get rid of this pointless function: -pub fn interner() -> @ident_interner { - return token::get_ident_interner(); -} - -pub fn from_srv( - srv: astsrv::Srv, - default_name: ~str -) -> doc::Doc { - - //! Use the AST service to create a document tree - - do astsrv::exec(srv) |ctxt| { - extract(ctxt.ast, default_name.clone()) - } -} - -pub fn extract( - crate: @ast::Crate, - default_name: ~str -) -> doc::Doc { - doc::Doc { - pages: ~[ - doc::CratePage(doc::CrateDoc { - topmod: top_moddoc_from_crate(crate, default_name), - }) - ] - } -} - -fn top_moddoc_from_crate( - crate: @ast::Crate, - default_name: ~str -) -> doc::ModDoc { - moddoc_from_mod(mk_itemdoc(ast::CRATE_NODE_ID, default_name), - crate.module.clone()) -} - -fn mk_itemdoc(id: ast::NodeId, name: ~str) -> doc::ItemDoc { - doc::ItemDoc { - id: id, - name: name, - path: ~[], - brief: None, - desc: None, - sections: ~[], - reexport: false - } -} - -fn moddoc_from_mod( - itemdoc: doc::ItemDoc, - module_: ast::_mod -) -> doc::ModDoc { - doc::ModDoc { - item: itemdoc, - items: do module_.items.iter().filter_map |item| { - let ItemDoc = mk_itemdoc(item.id, to_str(item.ident)); - match item.node.clone() { - ast::item_mod(m) => { - Some(doc::ModTag( - moddoc_from_mod(ItemDoc, m) - )) - } - ast::item_foreign_mod(nm) => { - Some(doc::NmodTag( - nmoddoc_from_mod(ItemDoc, nm) - )) - } - ast::item_fn(*) => { - Some(doc::FnTag( - fndoc_from_fn(ItemDoc) - )) - } - ast::item_static(*) => { - Some(doc::StaticTag( - staticdoc_from_static(ItemDoc) - )) - } - ast::item_enum(enum_definition, _) => { - Some(doc::EnumTag( - enumdoc_from_enum(ItemDoc, enum_definition.variants.clone()) - )) - } - ast::item_trait(_, _, methods) => { - Some(doc::TraitTag( - traitdoc_from_trait(ItemDoc, methods) - )) - } - ast::item_impl(_, _, _, methods) => { - Some(doc::ImplTag( - impldoc_from_impl(ItemDoc, methods) - )) - } - ast::item_ty(_, _) => { - Some(doc::TyTag( - tydoc_from_ty(ItemDoc) - )) - } - ast::item_struct(def, _) => { - Some(doc::StructTag( - structdoc_from_struct(ItemDoc, def) - )) - } - _ => None - } - }.collect(), - index: None - } -} - -fn nmoddoc_from_mod( - itemdoc: doc::ItemDoc, - module_: ast::foreign_mod -) -> doc::NmodDoc { - let mut fns = ~[]; - for item in module_.items.iter() { - let ItemDoc = mk_itemdoc(item.id, to_str(item.ident)); - match item.node { - ast::foreign_item_fn(*) => { - fns.push(fndoc_from_fn(ItemDoc)); - } - ast::foreign_item_static(*) => {} // XXX: Not implemented. - } - } - doc::NmodDoc { - item: itemdoc, - fns: fns, - index: None - } -} - -fn fndoc_from_fn(itemdoc: doc::ItemDoc) -> doc::FnDoc { - doc::SimpleItemDoc { - item: itemdoc, - sig: None - } -} - -fn staticdoc_from_static(itemdoc: doc::ItemDoc) -> doc::StaticDoc { - doc::SimpleItemDoc { - item: itemdoc, - sig: None - } -} - -fn enumdoc_from_enum( - itemdoc: doc::ItemDoc, - variants: ~[ast::variant] -) -> doc::EnumDoc { - doc::EnumDoc { - item: itemdoc, - variants: variantdocs_from_variants(variants) - } -} - -fn variantdocs_from_variants( - variants: ~[ast::variant] -) -> ~[doc::VariantDoc] { - variants.iter().map(variantdoc_from_variant).collect() -} - -fn variantdoc_from_variant(variant: &ast::variant) -> doc::VariantDoc { - doc::VariantDoc { - name: to_str(variant.node.name), - desc: None, - sig: None - } -} - -fn traitdoc_from_trait( - itemdoc: doc::ItemDoc, - methods: ~[ast::trait_method] -) -> doc::TraitDoc { - doc::TraitDoc { - item: itemdoc, - methods: do methods.iter().map |method| { - match (*method).clone() { - ast::required(ty_m) => { - doc::MethodDoc { - name: to_str(ty_m.ident), - brief: None, - desc: None, - sections: ~[], - sig: None, - implementation: doc::Required, - } - } - ast::provided(m) => { - doc::MethodDoc { - name: to_str(m.ident), - brief: None, - desc: None, - sections: ~[], - sig: None, - implementation: doc::Provided, - } - } - } - }.collect() - } -} - -fn impldoc_from_impl( - itemdoc: doc::ItemDoc, - methods: ~[@ast::method] -) -> doc::ImplDoc { - doc::ImplDoc { - item: itemdoc, - bounds_str: None, - trait_types: ~[], - self_ty: None, - methods: do methods.iter().map |method| { - doc::MethodDoc { - name: to_str(method.ident), - brief: None, - desc: None, - sections: ~[], - sig: None, - implementation: doc::Provided, - } - }.collect() - } -} - -fn tydoc_from_ty( - itemdoc: doc::ItemDoc -) -> doc::TyDoc { - doc::SimpleItemDoc { - item: itemdoc, - sig: None - } -} - -fn structdoc_from_struct( - itemdoc: doc::ItemDoc, - struct_def: @ast::struct_def -) -> doc::StructDoc { - doc::StructDoc { - item: itemdoc, - fields: do struct_def.fields.map |field| { - match field.node.kind { - ast::named_field(ident, _) => to_str(ident), - ast::unnamed_field => ~"(unnamed)", - } - }, - sig: None - } -} - -#[cfg(test)] -mod test { - use astsrv; - use doc; - use extract::{extract, from_srv}; - use parse; - - fn mk_doc(source: @str) -> doc::Doc { - let ast = parse::from_str(source); - debug!("ast=%?", ast); - extract(ast, ~"") - } - - #[test] - fn extract_empty_crate() { - let doc = mk_doc(@""); - assert!(doc.cratemod().mods().is_empty()); - assert!(doc.cratemod().fns().is_empty()); - } - - #[test] - fn extract_mods() { - let doc = mk_doc(@"mod a { mod b { } mod c { } }"); - assert!(doc.cratemod().mods()[0].name_() == ~"a"); - assert!(doc.cratemod().mods()[0].mods()[0].name_() == ~"b"); - assert!(doc.cratemod().mods()[0].mods()[1].name_() == ~"c"); - } - - #[test] - fn extract_fns_from_foreign_mods() { - let doc = mk_doc(@"extern { fn a(); }"); - assert!(doc.cratemod().nmods()[0].fns[0].name_() == ~"a"); - } - - #[test] - fn extract_mods_deep() { - let doc = mk_doc(@"mod a { mod b { mod c { } } }"); - assert!(doc.cratemod().mods()[0].mods()[0].mods()[0].name_() == - ~"c"); - } - - #[test] - fn extract_should_set_mod_ast_id() { - let doc = mk_doc(@"mod a { }"); - assert!(doc.cratemod().mods()[0].id() != 0); - } - - #[test] - fn extract_fns() { - let doc = mk_doc( - @"fn a() { } \ - mod b { fn c() { - } }"); - assert!(doc.cratemod().fns()[0].name_() == ~"a"); - assert!(doc.cratemod().mods()[0].fns()[0].name_() == ~"c"); - } - - #[test] - fn extract_should_set_fn_ast_id() { - let doc = mk_doc(@"fn a() { }"); - assert!(doc.cratemod().fns()[0].id() != 0); - } - - #[test] - fn extract_should_use_default_crate_name() { - let source = @""; - let ast = parse::from_str(source); - let doc = extract(ast, ~"burp"); - assert!(doc.cratemod().name_() == ~"burp"); - } - - #[test] - fn extract_from_seq_srv() { - let source = ~""; - do astsrv::from_str(source) |srv| { - let doc = from_srv(srv, ~"name"); - assert!(doc.cratemod().name_() == ~"name"); - } - } - - #[test] - fn should_extract_static_name_and_id() { - let doc = mk_doc(@"static a: int = 0;"); - assert!(doc.cratemod().statics()[0].id() != 0); - assert!(doc.cratemod().statics()[0].name_() == ~"a"); - } - - #[test] - fn should_extract_enums() { - let doc = mk_doc(@"enum e { v }"); - assert!(doc.cratemod().enums()[0].id() != 0); - assert!(doc.cratemod().enums()[0].name_() == ~"e"); - } - - #[test] - fn should_extract_enum_variants() { - let doc = mk_doc(@"enum e { v }"); - assert!(doc.cratemod().enums()[0].variants[0].name == ~"v"); - } - - #[test] - fn should_extract_traits() { - let doc = mk_doc(@"trait i { fn f(); }"); - assert!(doc.cratemod().traits()[0].name_() == ~"i"); - } - - #[test] - fn should_extract_trait_methods() { - let doc = mk_doc(@"trait i { fn f(); }"); - assert!(doc.cratemod().traits()[0].methods[0].name == ~"f"); - } - - #[test] - fn should_extract_impl_methods() { - let doc = mk_doc(@"impl int { fn f() { } }"); - assert!(doc.cratemod().impls()[0].methods[0].name == ~"f"); - } - - #[test] - fn should_extract_tys() { - let doc = mk_doc(@"type a = int;"); - assert!(doc.cratemod().types()[0].name_() == ~"a"); - } - - #[test] - fn should_extract_structs() { - let doc = mk_doc(@"struct Foo { field: () }"); - assert!(doc.cratemod().structs()[0].name_() == ~"Foo"); - } - - #[test] - fn should_extract_struct_fields() { - let doc = mk_doc(@"struct Foo { field: () }"); - assert!(doc.cratemod().structs()[0].fields[0] == ~"field"); - } -} diff --git a/src/librustdoc/fold.rs b/src/librustdoc/fold.rs index 3e74916228f..ae74f4e37c3 100644 --- a/src/librustdoc/fold.rs +++ b/src/librustdoc/fold.rs @@ -1,4 +1,4 @@ -// Copyright 2012 The Rust Project Developers. See the COPYRIGHT +// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // @@ -8,397 +8,92 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. - -use doc; -#[cfg(test)] use extract; -#[cfg(test)] use parse; - -pub struct Fold { - ctxt: T, - fold_doc: FoldDoc, - fold_crate: FoldCrate, - fold_item: FoldItem, - fold_mod: FoldMod, - fold_nmod: FoldNmod, - fold_fn: FoldFn, - fold_static: FoldStatic, - fold_enum: FoldEnum, - fold_trait: FoldTrait, - fold_impl: FoldImpl, - fold_type: FoldType, - fold_struct: FoldStruct -} - -impl Clone for Fold { - fn clone(&self) -> Fold { - Fold { - ctxt: self.ctxt.clone(), - fold_doc: self.fold_doc, - fold_crate: self.fold_crate, - fold_item: self.fold_item, - fold_mod: self.fold_mod, - fold_nmod: self.fold_nmod, - fold_fn: self.fold_fn, - fold_static: self.fold_static, - fold_enum: self.fold_enum, - fold_trait: self.fold_trait, - fold_impl: self.fold_impl, - fold_type: self.fold_type, - fold_struct: self.fold_struct - } - } -} - -type FoldDoc = @fn(fold: &Fold, doc: doc::Doc) -> doc::Doc; -type FoldCrate = @fn(fold: &Fold, doc: doc::CrateDoc) -> doc::CrateDoc; -type FoldItem = @fn(fold: &Fold, doc: doc::ItemDoc) -> doc::ItemDoc; -type FoldMod = @fn(fold: &Fold, doc: doc::ModDoc) -> doc::ModDoc; -type FoldNmod = @fn(fold: &Fold, doc: doc::NmodDoc) -> doc::NmodDoc; -type FoldFn = @fn(fold: &Fold, doc: doc::FnDoc) -> doc::FnDoc; -type FoldStatic = @fn(fold: &Fold, doc: doc::StaticDoc) -> doc::StaticDoc; -type FoldEnum = @fn(fold: &Fold, doc: doc::EnumDoc) -> doc::EnumDoc; -type FoldTrait = @fn(fold: &Fold, doc: doc::TraitDoc) -> doc::TraitDoc; -type FoldImpl = @fn(fold: &Fold, doc: doc::ImplDoc) -> doc::ImplDoc; -type FoldType = @fn(fold: &Fold, doc: doc::TyDoc) -> doc::TyDoc; -type FoldStruct = @fn(fold: &Fold, - doc: doc::StructDoc) -> doc::StructDoc; - -// This exists because fn types don't infer correctly as record -// initializers, but they do as function arguments -fn mk_fold( - ctxt: T, - fold_doc: FoldDoc, - fold_crate: FoldCrate, - fold_item: FoldItem, - fold_mod: FoldMod, - fold_nmod: FoldNmod, - fold_fn: FoldFn, - fold_static: FoldStatic, - fold_enum: FoldEnum, - fold_trait: FoldTrait, - fold_impl: FoldImpl, - fold_type: FoldType, - fold_struct: FoldStruct -) -> Fold { - Fold { - ctxt: ctxt, - fold_doc: fold_doc, - fold_crate: fold_crate, - fold_item: fold_item, - fold_mod: fold_mod, - fold_nmod: fold_nmod, - fold_fn: fold_fn, - fold_static: fold_static, - fold_enum: fold_enum, - fold_trait: fold_trait, - fold_impl: fold_impl, - fold_type: fold_type, - fold_struct: fold_struct - } -} - -pub fn default_any_fold(ctxt: T) -> Fold { - mk_fold( - ctxt, - |f, d| default_seq_fold_doc(f, d), - |f, d| default_seq_fold_crate(f, d), - |f, d| default_seq_fold_item(f, d), - |f, d| default_any_fold_mod(f, d), - |f, d| default_any_fold_nmod(f, d), - |f, d| default_seq_fold_fn(f, d), - |f, d| default_seq_fold_static(f, d), - |f, d| default_seq_fold_enum(f, d), - |f, d| default_seq_fold_trait(f, d), - |f, d| default_seq_fold_impl(f, d), - |f, d| default_seq_fold_type(f, d), - |f, d| default_seq_fold_struct(f, d) - ) -} - -pub fn default_seq_fold(ctxt: T) -> Fold { - mk_fold( - ctxt, - |f, d| default_seq_fold_doc(f, d), - |f, d| default_seq_fold_crate(f, d), - |f, d| default_seq_fold_item(f, d), - |f, d| default_seq_fold_mod(f, d), - |f, d| default_seq_fold_nmod(f, d), - |f, d| default_seq_fold_fn(f, d), - |f, d| default_seq_fold_static(f, d), - |f, d| default_seq_fold_enum(f, d), - |f, d| default_seq_fold_trait(f, d), - |f, d| default_seq_fold_impl(f, d), - |f, d| default_seq_fold_type(f, d), - |f, d| default_seq_fold_struct(f, d) - ) -} - -pub fn default_par_fold(ctxt: T) -> Fold { - mk_fold( - ctxt, - |f, d| default_seq_fold_doc(f, d), - |f, d| default_seq_fold_crate(f, d), - |f, d| default_seq_fold_item(f, d), - |f, d| default_par_fold_mod(f, d), - |f, d| default_par_fold_nmod(f, d), - |f, d| default_seq_fold_fn(f, d), - |f, d| default_seq_fold_static(f, d), - |f, d| default_seq_fold_enum(f, d), - |f, d| default_seq_fold_trait(f, d), - |f, d| default_seq_fold_impl(f, d), - |f, d| default_seq_fold_type(f, d), - |f, d| default_seq_fold_struct(f, d) - ) -} - -pub fn default_seq_fold_doc(fold: &Fold, doc: doc::Doc) -> doc::Doc { - doc::Doc { - pages: do doc.pages.iter().map |page| { - match (*page).clone() { - doc::CratePage(doc) => { - doc::CratePage((fold.fold_crate)(fold, doc)) - } - doc::ItemPage(doc) => { - doc::ItemPage(fold_ItemTag(fold, doc)) - } - } - }.collect(), - .. doc - } -} - -pub fn default_seq_fold_crate( - fold: &Fold, - doc: doc::CrateDoc -) -> doc::CrateDoc { - doc::CrateDoc { - topmod: (fold.fold_mod)(fold, doc.topmod.clone()) - } -} - -pub fn default_seq_fold_item( - _fold: &Fold, - doc: doc::ItemDoc -) -> doc::ItemDoc { - doc -} - -pub fn default_any_fold_mod( - fold: &Fold, - doc: doc::ModDoc -) -> doc::ModDoc { - doc::ModDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - items: doc.items.iter().map(|ItemTag| { - fold_ItemTag(fold, (*ItemTag).clone()) - }).collect(), - .. doc - } -} - -pub fn default_seq_fold_mod( - fold: &Fold, - doc: doc::ModDoc -) -> doc::ModDoc { - doc::ModDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - items: doc.items.iter().map(|ItemTag| { - fold_ItemTag(fold, (*ItemTag).clone()) - }).collect(), - .. doc - } -} - -pub fn default_par_fold_mod( - fold: &Fold, - doc: doc::ModDoc -) -> doc::ModDoc { - doc::ModDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - items: doc.items.iter().map(|ItemTag| { - fold_ItemTag(fold, (*ItemTag).clone()) - }).collect(), - .. doc - } -} - -pub fn default_any_fold_nmod( - fold: &Fold, - doc: doc::NmodDoc -) -> doc::NmodDoc { - doc::NmodDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - fns: doc.fns.iter().map(|FnDoc| { - (fold.fold_fn)(fold, (*FnDoc).clone()) - }).collect(), - .. doc - } -} - -pub fn default_seq_fold_nmod( - fold: &Fold, - doc: doc::NmodDoc -) -> doc::NmodDoc { - doc::NmodDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - fns: doc.fns.iter().map(|FnDoc| { - (fold.fold_fn)(fold, (*FnDoc).clone()) - }).collect(), - .. doc - } -} - -pub fn default_par_fold_nmod( - fold: &Fold, - doc: doc::NmodDoc -) -> doc::NmodDoc { - doc::NmodDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - fns: doc.fns.iter().map(|FnDoc| { - (fold.fold_fn)(fold, (*FnDoc).clone()) - }).collect(), - .. doc - } -} - -pub fn fold_ItemTag(fold: &Fold, doc: doc::ItemTag) -> doc::ItemTag { - match doc { - doc::ModTag(ModDoc) => { - doc::ModTag((fold.fold_mod)(fold, ModDoc)) - } - doc::NmodTag(nModDoc) => { - doc::NmodTag((fold.fold_nmod)(fold, nModDoc)) - } - doc::FnTag(FnDoc) => { - doc::FnTag((fold.fold_fn)(fold, FnDoc)) - } - doc::StaticTag(StaticDoc) => { - doc::StaticTag((fold.fold_static)(fold, StaticDoc)) - } - doc::EnumTag(EnumDoc) => { - doc::EnumTag((fold.fold_enum)(fold, EnumDoc)) - } - doc::TraitTag(TraitDoc) => { - doc::TraitTag((fold.fold_trait)(fold, TraitDoc)) - } - doc::ImplTag(ImplDoc) => { - doc::ImplTag((fold.fold_impl)(fold, ImplDoc)) - } - doc::TyTag(TyDoc) => { - doc::TyTag((fold.fold_type)(fold, TyDoc)) - } - doc::StructTag(StructDoc) => { - doc::StructTag((fold.fold_struct)(fold, StructDoc)) - } - } -} - -pub fn default_seq_fold_fn( - fold: &Fold, - doc: doc::FnDoc -) -> doc::FnDoc { - doc::SimpleItemDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc - } -} - -pub fn default_seq_fold_static( - fold: &Fold, - doc: doc::StaticDoc -) -> doc::StaticDoc { - doc::SimpleItemDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc - } -} - -pub fn default_seq_fold_enum( - fold: &Fold, - doc: doc::EnumDoc -) -> doc::EnumDoc { - doc::EnumDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc - } -} - -pub fn default_seq_fold_trait( - fold: &Fold, - doc: doc::TraitDoc -) -> doc::TraitDoc { - doc::TraitDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc - } -} - -pub fn default_seq_fold_impl( - fold: &Fold, - doc: doc::ImplDoc -) -> doc::ImplDoc { - doc::ImplDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc - } -} - -pub fn default_seq_fold_type( - fold: &Fold, - doc: doc::TyDoc -) -> doc::TyDoc { - doc::SimpleItemDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc - } -} - -pub fn default_seq_fold_struct( - fold: &Fold, - doc: doc::StructDoc -) -> doc::StructDoc { - doc::StructDoc { - item: (fold.fold_item)(fold, doc.item.clone()), - .. doc +use std; +use clean::*; +use std::iter::Extendable; + +pub trait DocFolder { + fn fold_item(&mut self, item: Item) -> Option { + self.fold_item_recur(item) + } + + /// don't override! + fn fold_item_recur(&mut self, item: Item) -> Option { + use std::util::swap; + let Item { attrs, name, source, visibility, id, inner } = item; + let inner = inner; + let c = |x| self.fold_item(x); + let inner = match inner { + StructItem(i) => { + let mut i = i; + let mut foo = ~[]; swap(&mut foo, &mut i.fields); + i.fields.extend(&mut foo.move_iter().filter_map(|x| self.fold_item(x))); + StructItem(i) + }, + ModuleItem(i) => { + ModuleItem(self.fold_mod(i)) + }, + EnumItem(i) => { + let mut i = i; + let mut foo = ~[]; swap(&mut foo, &mut i.variants); + i.variants.extend(&mut foo.move_iter().filter_map(|x| self.fold_item(x))); + EnumItem(i) + }, + TraitItem(i) => { + fn vtrm(this: &mut T, trm: TraitMethod) -> Option { + match trm { + Required(it) => { + match this.fold_item(it) { + Some(x) => return Some(Required(x)), + None => return None, + } + }, + Provided(it) => { + match this.fold_item(it) { + Some(x) => return Some(Provided(x)), + None => return None, + } + }, + } + } + let mut i = i; + let mut foo = ~[]; swap(&mut foo, &mut i.methods); + i.methods.extend(&mut foo.move_iter().filter_map(|x| vtrm(self, x))); + TraitItem(i) + }, + ImplItem(i) => { + let mut i = i; + let mut foo = ~[]; swap(&mut foo, &mut i.methods); + i.methods.extend(&mut foo.move_iter().filter_map(|x| self.fold_item(x))); + ImplItem(i) + }, + VariantItem(i) => { + let i2 = i.clone(); // this clone is small + match i.kind { + StructVariant(j) => { + let mut j = j; + let mut foo = ~[]; swap(&mut foo, &mut j.fields); + j.fields.extend(&mut foo.move_iter().filter_map(c)); + VariantItem(Variant {kind: StructVariant(j), ..i2}) + }, + _ => VariantItem(i2) + } + }, + x => x + }; + + Some(Item { attrs: attrs, name: name, source: source, inner: inner, + visibility: visibility, id: id }) + } + + fn fold_mod(&mut self, m: Module) -> Module { + Module { items: m.items.move_iter().filter_map(|i| self.fold_item(i)).collect() } + } + + fn fold_crate(&mut self, mut c: Crate) -> Crate { + c.module = match std::util::replace(&mut c.module, None) { + Some(module) => self.fold_item(module), None => None + }; + return c; } } - -#[test] -fn default_fold_should_produce_same_doc() { - let source = @"mod a { fn b() { } mod c { fn d() { } } }"; - let ast = parse::from_str(source); - let doc = extract::extract(ast, ~""); - let fld = default_seq_fold(()); - let folded = (fld.fold_doc)(&fld, doc.clone()); - assert_eq!(doc, folded); -} - -#[test] -fn default_fold_should_produce_same_statics() { - let source = @"static a: int = 0;"; - let ast = parse::from_str(source); - let doc = extract::extract(ast, ~""); - let fld = default_seq_fold(()); - let folded = (fld.fold_doc)(&fld, doc.clone()); - assert_eq!(doc, folded); -} - -#[test] -fn default_fold_should_produce_same_enums() { - let source = @"enum a { b }"; - let ast = parse::from_str(source); - let doc = extract::extract(ast, ~""); - let fld = default_seq_fold(()); - let folded = (fld.fold_doc)(&fld, doc.clone()); - assert_eq!(doc, folded); -} - -#[test] -fn default_parallel_fold_should_produce_same_doc() { - let source = @"mod a { fn b() { } mod c { fn d() { } } }"; - let ast = parse::from_str(source); - let doc = extract::extract(ast, ~""); - let fld = default_par_fold(()); - let folded = (fld.fold_doc)(&fld, doc.clone()); - assert_eq!(doc, folded); -} diff --git a/src/librustdoc/html/format.rs b/src/librustdoc/html/format.rs new file mode 100644 index 00000000000..4d0f6928d50 --- /dev/null +++ b/src/librustdoc/html/format.rs @@ -0,0 +1,364 @@ +// Copyright 2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +use std::fmt; +use std::local_data; +use std::rt::io; + +use syntax::ast; + +use clean; +use html::render::{cache_key, current_location_key}; + +pub struct VisSpace(Option); +pub struct Method<'self>(&'self clean::SelfTy, &'self clean::FnDecl); + +impl fmt::Default for clean::Generics { + fn fmt(g: &clean::Generics, f: &mut fmt::Formatter) { + if g.lifetimes.len() == 0 && g.type_params.len() == 0 { return } + f.buf.write("<".as_bytes()); + + for (i, life) in g.lifetimes.iter().enumerate() { + if i > 0 { f.buf.write(", ".as_bytes()); } + write!(f.buf, "{}", *life); + } + + if g.type_params.len() > 0 { + if g.lifetimes.len() > 0 { f.buf.write(", ".as_bytes()); } + + for (i, tp) in g.type_params.iter().enumerate() { + if i > 0 { f.buf.write(", ".as_bytes()) } + f.buf.write(tp.name.as_bytes()); + + if tp.bounds.len() > 0 { + f.buf.write(": ".as_bytes()); + for (i, bound) in tp.bounds.iter().enumerate() { + if i > 0 { f.buf.write(" + ".as_bytes()); } + write!(f.buf, "{}", *bound); + } + } + } + } + f.buf.write(">".as_bytes()); + } +} + +impl fmt::Default for clean::Lifetime { + fn fmt(l: &clean::Lifetime, f: &mut fmt::Formatter) { + f.buf.write("'".as_bytes()); + f.buf.write(l.as_bytes()); + } +} + +impl fmt::Default for clean::TyParamBound { + fn fmt(bound: &clean::TyParamBound, f: &mut fmt::Formatter) { + match *bound { + clean::RegionBound => { + f.buf.write("'static".as_bytes()) + } + clean::TraitBound(ref ty) => { + write!(f.buf, "{}", *ty); + } + } + } +} + +impl fmt::Default for clean::Path { + fn fmt(path: &clean::Path, f: &mut fmt::Formatter) { + if path.global { f.buf.write("::".as_bytes()) } + for (i, seg) in path.segments.iter().enumerate() { + if i > 0 { f.buf.write("::".as_bytes()) } + f.buf.write(seg.name.as_bytes()); + + if seg.lifetime.is_some() || seg.types.len() > 0 { + f.buf.write("<".as_bytes()); + match seg.lifetime { + Some(ref lifetime) => write!(f.buf, "{}", *lifetime), + None => {} + } + for (i, ty) in seg.types.iter().enumerate() { + if i > 0 || seg.lifetime.is_some() { + f.buf.write(", ".as_bytes()); + } + write!(f.buf, "{}", *ty); + } + f.buf.write(">".as_bytes()); + } + } + } +} + +fn resolved_path(w: &mut io::Writer, id: ast::NodeId, path: &clean::Path) { + // The generics will get written to both the title and link + let mut generics = ~""; + let last = path.segments.last(); + if last.lifetime.is_some() || last.types.len() > 0 { + generics.push_str("<"); + match last.lifetime { + Some(ref lifetime) => generics.push_str(format!("{}", *lifetime)), + None => {} + } + for (i, ty) in last.types.iter().enumerate() { + if i > 0 || last.lifetime.is_some() { + generics.push_str(", "); + } + generics.push_str(format!("{}", *ty)); + } + generics.push_str(">"); + } + + // Did someone say rightward-drift? + do local_data::get(current_location_key) |loc| { + let loc = loc.unwrap(); + do local_data::get(cache_key) |cache| { + do cache.unwrap().read |cache| { + match cache.paths.find(&id) { + // This is a documented path, link to it! + Some(&(ref fqp, shortty)) => { + let fqn = fqp.connect("::"); + let mut same = 0; + for (a, b) in loc.iter().zip(fqp.iter()) { + if *a == *b { + same += 1; + } else { + break; + } + } + + let mut url = ~""; + for _ in range(same, loc.len()) { + url.push_str("../"); + } + if same == fqp.len() { + url.push_str(shortty); + url.push_str("."); + url.push_str(*fqp.last()); + url.push_str(".html"); + } else { + let remaining = fqp.slice_from(same); + let to_link = remaining.slice_to(remaining.len() - 1); + for component in to_link.iter() { + url.push_str(*component); + url.push_str("/"); + } + url.push_str(shortty); + url.push_str("."); + url.push_str(*remaining.last()); + url.push_str(".html"); + } + + write!(w, "{}{}", + shortty, url, fqn, last.name, generics); + } + None => { + write!(w, "{}{}", last.name, generics); + } + }; + } + } + } +} + +impl fmt::Default for clean::Type { + fn fmt(g: &clean::Type, f: &mut fmt::Formatter) { + match *g { + clean::TyParamBinder(id) | clean::Generic(id) => { + do local_data::get(cache_key) |cache| { + do cache.unwrap().read |m| { + f.buf.write(m.typarams.get(&id).as_bytes()); + } + } + } + clean::Unresolved(*) => unreachable!(), + clean::ResolvedPath{id, typarams: ref typarams, path: ref path} => { + resolved_path(f.buf, id, path); + match *typarams { + Some(ref params) => { + f.buf.write("<".as_bytes()); + for (i, param) in params.iter().enumerate() { + if i > 0 { f.buf.write(", ".as_bytes()) } + write!(f.buf, "{}", *param); + } + f.buf.write(">".as_bytes()); + } + None => {} + } + } + // XXX: this should be a link + clean::External(ref a, _) => { + write!(f.buf, "{}", *a); + } + clean::Self(*) => f.buf.write("Self".as_bytes()), + clean::Primitive(prim) => { + let s = match prim { + ast::ty_int(ast::ty_i) => "int", + ast::ty_int(ast::ty_i8) => "i8", + ast::ty_int(ast::ty_i16) => "i16", + ast::ty_int(ast::ty_i32) => "i32", + ast::ty_int(ast::ty_i64) => "i64", + ast::ty_uint(ast::ty_u) => "uint", + ast::ty_uint(ast::ty_u8) => "u8", + ast::ty_uint(ast::ty_u16) => "u16", + ast::ty_uint(ast::ty_u32) => "u32", + ast::ty_uint(ast::ty_u64) => "u64", + ast::ty_float(ast::ty_f) => "float", + ast::ty_float(ast::ty_f32) => "f32", + ast::ty_float(ast::ty_f64) => "f64", + ast::ty_str => "str", + ast::ty_bool => "bool", + ast::ty_char => "char", + }; + f.buf.write(s.as_bytes()); + } + clean::Closure(ref decl) => { + f.buf.write(match decl.sigil { + ast::BorrowedSigil => "&", + ast::ManagedSigil => "@", + ast::OwnedSigil => "~", + }.as_bytes()); + match decl.region { + Some(ref region) => write!(f.buf, "{} ", *region), + None => {} + } + write!(f.buf, "{}{}fn{}", + match decl.purity { + ast::unsafe_fn => "unsafe ", + ast::extern_fn => "extern ", + ast::impure_fn => "" + }, + match decl.onceness { + ast::Once => "once ", + ast::Many => "", + }, + decl.decl); + // XXX: where are bounds and lifetimes printed?! + } + clean::BareFunction(ref decl) => { + write!(f.buf, "{}{}fn{}{}", + match decl.purity { + ast::unsafe_fn => "unsafe ", + ast::extern_fn => "extern ", + ast::impure_fn => "" + }, + match decl.abi { + ~"" | ~"\"Rust\"" => ~"", + ref s => " " + *s + " ", + }, + decl.generics, + decl.decl); + } + clean::Tuple(ref typs) => { + f.buf.write("(".as_bytes()); + for (i, typ) in typs.iter().enumerate() { + if i > 0 { f.buf.write(", ".as_bytes()) } + write!(f.buf, "{}", *typ); + } + f.buf.write(")".as_bytes()); + } + clean::Vector(ref t) => write!(f.buf, "[{}]", **t), + clean::FixedVector(ref t, ref s) => { + write!(f.buf, "[{}, ..{}]", **t, *s); + } + clean::String => f.buf.write("str".as_bytes()), + clean::Bool => f.buf.write("bool".as_bytes()), + clean::Unit => f.buf.write("()".as_bytes()), + clean::Bottom => f.buf.write("!".as_bytes()), + clean::Unique(ref t) => write!(f.buf, "~{}", **t), + clean::Managed(m, ref t) => { + write!(f.buf, "@{}{}", + match m { + clean::Mutable => "mut ", + clean::Immutable => "", + }, **t) + } + clean::RawPointer(m, ref t) => { + write!(f.buf, "*{}{}", + match m { + clean::Mutable => "mut ", + clean::Immutable => "", + }, **t) + } + clean::BorrowedRef{ lifetime: ref l, mutability, type_: ref ty} => { + let lt = match *l { Some(ref l) => format!("{} ", *l), _ => ~"" }; + write!(f.buf, "&{}{}{}", + lt, + match mutability { + clean::Mutable => "mut ", + clean::Immutable => "", + }, + **ty); + } + } + } +} + +impl fmt::Default for clean::FnDecl { + fn fmt(d: &clean::FnDecl, f: &mut fmt::Formatter) { + let mut args = ~""; + for (i, input) in d.inputs.iter().enumerate() { + if i > 0 { args.push_str(", "); } + if input.name.len() > 0 { + args.push_str(format!("{}: ", input.name)); + } + args.push_str(format!("{}", input.type_)); + } + write!(f.buf, "({args}){arrow, select, yes{ -> {ret}} other{}}", + args = args, + arrow = match d.output { clean::Unit => "no", _ => "yes" }, + ret = d.output); + } +} + +impl<'self> fmt::Default for Method<'self> { + fn fmt(m: &Method<'self>, f: &mut fmt::Formatter) { + let Method(selfty, d) = *m; + let mut args = ~""; + match *selfty { + clean::SelfStatic => {}, + clean::SelfValue => args.push_str("self"), + clean::SelfOwned => args.push_str("~self"), + clean::SelfManaged(clean::Mutable) => args.push_str("@mut self"), + clean::SelfManaged(clean::Immutable) => args.push_str("@self"), + clean::SelfBorrowed(Some(ref lt), clean::Immutable) => { + args.push_str(format!("&{} self", *lt)); + } + clean::SelfBorrowed(Some(ref lt), clean::Mutable) => { + args.push_str(format!("&{} mut self", *lt)); + } + clean::SelfBorrowed(None, clean::Mutable) => { + args.push_str("&mut self"); + } + clean::SelfBorrowed(None, clean::Immutable) => { + args.push_str("&self"); + } + } + for (i, input) in d.inputs.iter().enumerate() { + if i > 0 || args.len() > 0 { args.push_str(", "); } + if input.name.len() > 0 { + args.push_str(format!("{}: ", input.name)); + } + args.push_str(format!("{}", input.type_)); + } + write!(f.buf, "({args}){arrow, select, yes{ -> {ret}} other{}}", + args = args, + arrow = match d.output { clean::Unit => "no", _ => "yes" }, + ret = d.output); + } +} + +impl fmt::Default for VisSpace { + fn fmt(v: &VisSpace, f: &mut fmt::Formatter) { + match **v { + Some(ast::public) => { write!(f.buf, "pub "); } + Some(ast::private) => { write!(f.buf, "priv "); } + Some(ast::inherited) | None => {} + } + } +} diff --git a/src/librustdoc/html/layout.rs b/src/librustdoc/html/layout.rs new file mode 100644 index 00000000000..fcf13779389 --- /dev/null +++ b/src/librustdoc/html/layout.rs @@ -0,0 +1,130 @@ +// Copyright 2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +use std::fmt; +use std::rt::io; + +#[deriving(Clone)] +pub struct Layout { + logo: ~str, + favicon: ~str, + crate: ~str, +} + +pub struct Page<'self> { + title: &'self str, + ty: &'self str, + root_path: &'self str, +} + +pub fn render( + dst: &mut io::Writer, layout: &Layout, page: &Page, sidebar: &S, t: &T) +{ + write!(dst, " + + + + + {title} + + + + + {favicon, select, none{} other{ + }} + + + + +
+ {logo, select, none{} other{ + + }} + + {sidebar} +
+ + + +
{content}
+ +
+ + + + + + +
+
+

Keyboard shortcuts

+
+
?
+
Show this help dialog
+
S
+
Focus the search field
+
↑
+
Move up in search results
+
↓
+
Move down in search results
+
&\\#9166;
+
Go to active search result
+
+
+
+

Search tricks

+

+ Prefix searches with a type followed by a colon (e.g. + fn:) to restrict the search to a given type. +

+

+ Accepted types are: fn, mod, + struct (or str), enum, + trait, typedef (or + tdef). +

+
+
+ + +", + content = *t, + root_path = page.root_path, + ty = page.ty, + logo = nonestr(layout.logo), + title = page.title, + favicon = nonestr(layout.favicon), + sidebar = *sidebar, + crate = layout.crate, + ); +} + +fn boolstr(b: bool) -> &'static str { + if b { "true" } else { "false" } +} + +fn nonestr<'a>(s: &'a str) -> &'a str { + if s == "" { "none" } else { s } +} diff --git a/src/librustdoc/html/markdown.rs b/src/librustdoc/html/markdown.rs new file mode 100644 index 00000000000..14e2327550b --- /dev/null +++ b/src/librustdoc/html/markdown.rs @@ -0,0 +1,54 @@ +// Copyright 2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +use std::fmt; +use std::rt::io::Reader; +use std::rt::io::pipe::PipeStream; +use std::rt::io::process::{ProcessConfig, Process, CreatePipe}; +use std::rt::io; + +pub struct Markdown<'self>(&'self str); + +impl<'self> fmt::Default for Markdown<'self> { + fn fmt(md: &Markdown<'self>, fmt: &mut fmt::Formatter) { + if md.len() == 0 { return; } + + // Create the pandoc process + do io::io_error::cond.trap(|err| { + fail2!("Error executing `pandoc`: {}", err.desc); + }).inside { + let io = ~[CreatePipe(PipeStream::new().unwrap(), true, false), + CreatePipe(PipeStream::new().unwrap(), false, true)]; + let args = ProcessConfig { + program: "pandoc", + args: [], + env: None, + cwd: None, + io: io, + }; + let mut p = Process::new(args).expect("couldn't fork for pandoc"); + + // Write the markdown to stdin and close it. + p.io[0].get_mut_ref().write(md.as_bytes()); + p.io[0] = None; + + // Ferry the output from pandoc over to the destination buffer. + let mut buf = [0, ..1024]; + loop { + match p.io[1].get_mut_ref().read(buf) { + None | Some(0) => { break } + Some(n) => { + fmt.buf.write(buf.slice_to(n)); + } + } + } + } + } +} diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs new file mode 100644 index 00000000000..b004061e04a --- /dev/null +++ b/src/librustdoc/html/render.rs @@ -0,0 +1,1108 @@ +// Copyright 2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +use std::cell::Cell; +use std::comm::{SharedPort, SharedChan}; +use std::comm; +use std::fmt; +use std::hashmap::HashMap; +use std::local_data; +use std::rt::io::buffered::BufferedWriter; +use std::rt::io::file::{FileInfo, DirectoryInfo}; +use std::rt::io::file; +use std::rt::io; +use std::task; +use std::unstable::finally::Finally; +use std::util; +use std::vec; + +use extra::arc::RWArc; +use extra::json::ToJson; +use extra::sort; + +use syntax::ast; + +use clean; +use doctree; +use fold::DocFolder; +use html::format::{VisSpace, Method}; +use html::layout; +use html::markdown::Markdown; + +#[deriving(Clone)] +pub struct Context { + current: ~[~str], + root_path: ~str, + dst: Path, + layout: layout::Layout, + sidebar: HashMap<~str, ~[~str]>, +} + +enum Implementor { + PathType(clean::Type), + OtherType(clean::Generics, /* trait */ clean::Type, /* for */ clean::Type), +} + +struct Cache { + // typaram id => name of that typaram + typarams: HashMap, + // type id => all implementations for that type + impls: HashMap, + // path id => (full qualified path, shortty) -- used to generate urls + paths: HashMap, + // trait id => method name => dox + traits: HashMap>, + // trait id => implementors of the trait + implementors: HashMap, + + priv stack: ~[~str], + priv parent_stack: ~[ast::NodeId], + priv search_index: ~[IndexItem], +} + +struct Item<'self> { cx: &'self Context, item: &'self clean::Item, } +struct Sidebar<'self> { cx: &'self Context, item: &'self clean::Item, } + +struct IndexItem { + ty: &'static str, + name: ~str, + path: ~str, + desc: ~str, + parent: Option, +} + +local_data_key!(pub cache_key: RWArc) +local_data_key!(pub current_location_key: ~[~str]) + +/// Generates the documentation for `crate` into the directory `dst` +pub fn run(mut crate: clean::Crate, dst: Path) { + let mut cx = Context { + dst: dst, + current: ~[], + root_path: ~"", + sidebar: HashMap::new(), + layout: layout::Layout { + logo: ~"", + favicon: ~"", + crate: crate.name.clone(), + }, + }; + mkdir(&cx.dst); + + match crate.module.get_ref().doc_list() { + Some(attrs) => { + for attr in attrs.iter() { + match *attr { + clean::NameValue(~"html_favicon_url", ref s) => { + cx.layout.favicon = s.to_owned(); + } + clean::NameValue(~"html_logo_url", ref s) => { + cx.layout.logo = s.to_owned(); + } + _ => {} + } + } + } + None => {} + } + + // Crawl the crate to build various caches used for the output + let mut cache = Cache { + impls: HashMap::new(), + typarams: HashMap::new(), + paths: HashMap::new(), + traits: HashMap::new(), + implementors: HashMap::new(), + stack: ~[], + parent_stack: ~[], + search_index: ~[], + }; + cache.stack.push(crate.name.clone()); + crate = cache.fold_crate(crate); + + // Add all the static files + write(cx.dst.push("jquery.js"), include_str!("static/jquery-2.0.3.min.js")); + write(cx.dst.push("main.js"), include_str!("static/main.js")); + write(cx.dst.push("main.css"), include_str!("static/main.css")); + write(cx.dst.push("normalize.css"), include_str!("static/normalize.css")); + write(cx.dst.push("index.html"), format!(" + + + + ", crate.name)); + + { + mkdir(&cx.dst.push(crate.name)); + let dst = cx.dst.push(crate.name).push("search-index.js"); + let mut w = BufferedWriter::new(dst.open_writer(io::CreateOrTruncate)); + let w = &mut w as &mut io::Writer; + write!(w, "var searchIndex = ["); + for (i, item) in cache.search_index.iter().enumerate() { + if i > 0 { write!(w, ","); } + write!(w, "\\{ty:\"{}\",name:\"{}\",path:\"{}\",desc:{}", + item.ty, item.name, item.path, + item.desc.to_json().to_str()) + match item.parent { + Some(id) => { write!(w, ",parent:'{}'", id); } + None => {} + } + write!(w, "\\}"); + } + write!(w, "];"); + write!(w, "var allPaths = \\{"); + for (i, (&id, &(ref fqp, short))) in cache.paths.iter().enumerate() { + if i > 0 { write!(w, ","); } + write!(w, "'{}':\\{type:'{}',name:'{}'\\}", id, short, *fqp.last()); + } + write!(w, "\\};"); + w.flush(); + } + + // Now render the whole crate. + cx.crate(crate, cache); +} + +fn write(dst: Path, contents: &str) { + let mut w = dst.open_writer(io::CreateOrTruncate); + w.write(contents.as_bytes()); +} + +fn mkdir(path: &Path) { + do io::io_error::cond.trap(|err| { + error2!("Couldn't create directory `{}`: {}", + path.to_str(), err.desc); + fail!() + }).inside { + if !path.is_dir() { + file::mkdir(path); + } + } +} + +impl<'self> DocFolder for Cache { + fn fold_item(&mut self, item: clean::Item) -> Option { + // Register any generics to their corresponding string. This is used + // when pretty-printing types + match item.inner { + clean::StructItem(ref s) => self.generics(&s.generics), + clean::EnumItem(ref e) => self.generics(&e.generics), + clean::FunctionItem(ref f) => self.generics(&f.generics), + clean::TypedefItem(ref t) => self.generics(&t.generics), + clean::TraitItem(ref t) => self.generics(&t.generics), + clean::ImplItem(ref i) => self.generics(&i.generics), + clean::TyMethodItem(ref i) => self.generics(&i.generics), + clean::MethodItem(ref i) => self.generics(&i.generics), + _ => {} + } + + // Propagate a trait methods' documentation to all implementors of the + // trait + match item.inner { + clean::TraitItem(ref t) => { + let mut dox = HashMap::new(); + for meth in t.methods.iter() { + let it = meth.item(); + match it.doc_value() { + None => {} + Some(s) => { + dox.insert(it.name.get_ref().to_owned(), + s.to_owned()); + } + } + } + self.traits.insert(item.id, dox); + } + _ => {} + } + + // Collect all the implementors of traits. + match item.inner { + clean::ImplItem(ref i) => { + match i.trait_ { + Some(clean::ResolvedPath{ id, _ }) => { + let v = do self.implementors.find_or_insert_with(id) |_|{ + ~[] + }; + match i.for_ { + clean::ResolvedPath{_} => { + v.unshift(PathType(i.for_.clone())); + } + _ => { + v.push(OtherType(i.generics.clone(), + i.trait_.get_ref().clone(), + i.for_.clone())); + } + } + } + Some(*) | None => {} + } + } + _ => {} + } + + // Index this method for searching later on + match item.name { + Some(ref s) => { + let parent = match item.inner { + clean::TyMethodItem(*) | clean::VariantItem(*) => { + Some((Some(*self.parent_stack.last()), + self.stack.slice_to(self.stack.len() - 1))) + + } + clean::MethodItem(*) => { + if self.parent_stack.len() == 0 { + None + } else { + Some((Some(*self.parent_stack.last()), + self.stack.as_slice())) + } + } + _ => Some((None, self.stack.as_slice())) + }; + match parent { + Some((parent, path)) => { + self.search_index.push(IndexItem { + ty: shortty(&item), + name: s.to_owned(), + path: path.connect("::"), + desc: shorter(item.doc_value()).to_owned(), + parent: parent, + }); + } + None => {} + } + } + None => {} + } + + // Keep track of the fully qualified path for this item. + let pushed = if item.name.is_some() { + let n = item.name.get_ref(); + if n.len() > 0 { + self.stack.push(n.to_owned()); + true + } else { false } + } else { false }; + match item.inner { + clean::StructItem(*) | clean::EnumItem(*) | + clean::TypedefItem(*) | clean::TraitItem(*) => { + self.paths.insert(item.id, (self.stack.clone(), shortty(&item))); + } + _ => {} + } + + // Maintain the parent stack + let parent_pushed = match item.inner { + clean::TraitItem(*) | clean::EnumItem(*) => { + self.parent_stack.push(item.id); true + } + clean::ImplItem(ref i) => { + match i.for_ { + clean::ResolvedPath{ id, _ } => { + self.parent_stack.push(id); true + } + _ => false + } + } + _ => false + }; + + // Once we've recursively found all the generics, then hoard off all the + // implementations elsewhere + let ret = match self.fold_item_recur(item) { + Some(item) => { + match item.inner { + clean::ImplItem(i) => { + match i.for_ { + clean::ResolvedPath { id, _ } => { + let v = do self.impls.find_or_insert_with(id) |_| { + ~[] + }; + v.push(i); + } + _ => {} + } + None + } + _ => Some(item), + } + } + i => i, + }; + + if pushed { self.stack.pop(); } + if parent_pushed { self.parent_stack.pop(); } + return ret; + } +} + +impl<'self> Cache { + fn generics(&mut self, generics: &clean::Generics) { + for typ in generics.type_params.iter() { + self.typarams.insert(typ.id, typ.name.clone()); + } + } +} + +impl Context { + fn recurse(&mut self, s: ~str, f: &fn(&mut Context) -> T) -> T { + // Recurse in the directory structure and change the "root path" to make + // sure it always points to the top (relatively) + if s.len() == 0 { + fail2!("what {:?}", self); + } + let next = self.dst.push(s); + let prev = util::replace(&mut self.dst, next); + self.root_path.push_str("../"); + self.current.push(s); + + mkdir(&self.dst); + let ret = f(self); + + // Go back to where we were at + self.dst = prev; + let len = self.root_path.len(); + self.root_path.truncate(len - 3); + self.current.pop(); + + return ret; + } + + /// Processes + fn crate(self, mut crate: clean::Crate, cache: Cache) { + enum Work { + Die, + Process(Context, clean::Item), + } + enum Progress { JobNew, JobDone } + static WORKERS: int = 10; + + let mut item = match crate.module.take() { + Some(i) => i, + None => return + }; + item.name = Some(crate.name); + + let (port, chan) = comm::stream::(); + let port = SharedPort::new(port); + let chan = SharedChan::new(chan); + let (prog_port, prog_chan) = comm::stream(); + let prog_chan = SharedChan::new(prog_chan); + let cache = RWArc::new(cache); + + for i in range(0, WORKERS) { + let port = port.clone(); + let chan = chan.clone(); + let prog_chan = prog_chan.clone(); + + let mut task = task::task(); + task.unlinked(); // we kill things manually + task.name(format!("worker{}", i)); + do task.spawn_with(cache.clone()) |cache| { + local_data::set(cache_key, cache); + loop { + match port.recv() { + Process(cx, item) => { + let mut cx = cx; + let item = Cell::new(item); + do (|| { + do cx.item(item.take()) |cx, item| { + prog_chan.send(JobNew); + chan.send(Process(cx.clone(), item)); + } + }).finally { + // If we fail, everything else should still get + // completed + prog_chan.send(JobDone); + } + } + Die => break, + } + } + } + } + + let watcher_chan = chan.clone(); + let (done_port, done_chan) = comm::stream(); + do task::spawn { + let mut jobs = 0; + loop { + match prog_port.recv() { + JobNew => jobs += 1, + JobDone => jobs -= 1, + } + + if jobs == 0 { break } + } + + for _ in range(0, WORKERS) { + watcher_chan.send(Die); + } + done_chan.send(()); + } + + prog_chan.send(JobNew); + chan.send(Process(self, item)); + done_port.recv(); + } + + fn item(&mut self, item: clean::Item, f: &fn(&mut Context, clean::Item)) { + fn render(w: io::file::FileWriter, cx: &mut Context, it: &clean::Item, + pushname: bool) { + // A little unfortunate that this is done like this, but it sure + // does make formatting *a lot* nicer. + local_data::set(current_location_key, cx.current.clone()); + + let mut title = cx.current.connect("::"); + if pushname { + if title.len() > 0 { title.push_str("::"); } + title.push_str(*it.name.get_ref()); + } + title.push_str(" - Rust"); + let page = layout::Page { + ty: shortty(it), + root_path: cx.root_path, + title: title, + }; + + // We have a huge number of calls to write, so try to alleviate some + // of the pain by using a buffered writer instead of invoking the + // write sycall all the time. + let mut writer = BufferedWriter::new(w); + layout::render(&mut writer as &mut io::Writer, &cx.layout, &page, + &Sidebar{ cx: cx, item: it }, + &Item{ cx: cx, item: it }); + writer.flush(); + } + + match item.inner { + clean::ModuleItem(*) => { + let name = item.name.get_ref().to_owned(); + let item = Cell::new(item); + do self.recurse(name) |this| { + let item = item.take(); + let dst = this.dst.push("index.html"); + let writer = dst.open_writer(io::CreateOrTruncate); + render(writer.unwrap(), this, &item, false); + + let m = match item.inner { + clean::ModuleItem(m) => m, + _ => unreachable!() + }; + this.sidebar = build_sidebar(&m); + for item in m.items.move_iter() { + f(this, item); + } + } + } + _ if item.name.is_some() => { + let dst = self.dst.push(item_path(&item)); + let writer = dst.open_writer(io::CreateOrTruncate); + render(writer.unwrap(), self, &item, true); + } + _ => {} + } + } +} + +fn shortty(item: &clean::Item) -> &'static str { + match item.inner { + clean::ModuleItem(*) => "mod", + clean::StructItem(*) => "struct", + clean::EnumItem(*) => "enum", + clean::FunctionItem(*) => "fn", + clean::TypedefItem(*) => "typedef", + clean::StaticItem(*) => "static", + clean::TraitItem(*) => "trait", + clean::ImplItem(*) => "impl", + clean::ViewItemItem(*) => "viewitem", + clean::TyMethodItem(*) => "tymethod", + clean::MethodItem(*) => "method", + clean::StructFieldItem(*) => "structfield", + clean::VariantItem(*) => "variant", + } +} + +impl<'self> Item<'self> { + fn ismodule(&self) -> bool { + match self.item.inner { + clean::ModuleItem(*) => true, _ => false + } + } +} + +impl<'self> fmt::Default for Item<'self> { + fn fmt(it: &Item<'self>, fmt: &mut fmt::Formatter) { + // Write the breadcrumb trail header for the top + write!(fmt.buf, "

"); + match it.item.inner { + clean::ModuleItem(*) => write!(fmt.buf, "Module "), + clean::FunctionItem(*) => write!(fmt.buf, "Function "), + clean::TraitItem(*) => write!(fmt.buf, "Trait "), + clean::StructItem(*) => write!(fmt.buf, "Struct "), + clean::EnumItem(*) => write!(fmt.buf, "Enum "), + _ => {} + } + let cur = it.cx.current.as_slice(); + let amt = if it.ismodule() { cur.len() - 1 } else { cur.len() }; + for (i, component) in cur.iter().enumerate().take(amt) { + let mut trail = ~""; + for _ in range(0, cur.len() - i - 1) { + trail.push_str("../"); + } + write!(fmt.buf, "{}::", + trail, component.as_slice()); + } + write!(fmt.buf, "{}

", + shortty(it.item), it.item.name.get_ref().as_slice()); + + match it.item.inner { + clean::ModuleItem(ref m) => item_module(fmt.buf, it.cx, + it.item, m.items), + clean::FunctionItem(ref f) => item_function(fmt.buf, it.item, f), + clean::TraitItem(ref t) => item_trait(fmt.buf, it.item, t), + clean::StructItem(ref s) => item_struct(fmt.buf, it.item, s), + clean::EnumItem(ref e) => item_enum(fmt.buf, it.item, e), + clean::TypedefItem(ref t) => item_typedef(fmt.buf, it.item, t), + _ => {} + } + } +} + +fn item_path(item: &clean::Item) -> ~str { + match item.inner { + clean::ModuleItem(*) => *item.name.get_ref() + "/index.html", + _ => shortty(item) + "." + *item.name.get_ref() + ".html" + } +} + +fn full_path(cx: &Context, item: &clean::Item) -> ~str { + let mut s = cx.current.connect("::"); + s.push_str("::"); + s.push_str(item.name.get_ref().as_slice()); + return s; +} + +fn blank<'a>(s: Option<&'a str>) -> &'a str { + match s { + Some(s) => s, + None => "" + } +} + +fn shorter<'a>(s: Option<&'a str>) -> &'a str { + match s { + Some(s) => match s.find_str("\n\n") { + Some(pos) => s.slice_to(pos), + None => s, + }, + None => "" + } +} + +fn document(w: &mut io::Writer, item: &clean::Item) { + match item.doc_value() { + Some(s) => { + write!(w, "
{}
", Markdown(s)); + } + None => {} + } +} + +fn item_module(w: &mut io::Writer, cx: &Context, + item: &clean::Item, items: &[clean::Item]) { + document(w, item); + let mut indices = vec::from_fn(items.len(), |i| i); + + fn lt(i1: &clean::Item, i2: &clean::Item) -> bool { + if shortty(i1) == shortty(i2) { + return i1.name < i2.name; + } + match (&i1.inner, &i2.inner) { + (&clean::ViewItemItem(*), _) => true, + (_, &clean::ViewItemItem(*)) => false, + (&clean::ModuleItem(*), _) => true, + (_, &clean::ModuleItem(*)) => false, + (&clean::StructItem(*), _) => true, + (_, &clean::StructItem(*)) => false, + (&clean::EnumItem(*), _) => true, + (_, &clean::EnumItem(*)) => false, + (&clean::StaticItem(*), _) => true, + (_, &clean::StaticItem(*)) => false, + (&clean::TraitItem(*), _) => true, + (_, &clean::TraitItem(*)) => false, + (&clean::FunctionItem(*), _) => true, + (_, &clean::FunctionItem(*)) => false, + (&clean::TypedefItem(*), _) => true, + (_, &clean::TypedefItem(*)) => false, + _ => false, + } + } + + do sort::quick_sort(indices) |&i1, &i2| { + lt(&items[i1], &items[i2]) + } + + let mut curty = ""; + for &idx in indices.iter() { + let myitem = &items[idx]; + if myitem.name.is_none() { loop } + + let myty = shortty(myitem); + if myty != curty { + if curty != "" { + write!(w, ""); + } + curty = myty; + write!(w, "

{}

\n", match myitem.inner { + clean::ModuleItem(*) => "Modules", + clean::StructItem(*) => "Structs", + clean::EnumItem(*) => "Enums", + clean::FunctionItem(*) => "Functions", + clean::TypedefItem(*) => "Type Definitions", + clean::StaticItem(*) => "Statics", + clean::TraitItem(*) => "Traits", + clean::ImplItem(*) => "Implementations", + clean::ViewItemItem(*) => "Reexports", + clean::TyMethodItem(*) => "Type Methods", + clean::MethodItem(*) => "Methods", + clean::StructFieldItem(*) => "Struct Fields", + clean::VariantItem(*) => "Variants", + }); + } + + match myitem.inner { + clean::StaticItem(ref s) => { + struct Initializer<'self>(&'self str); + impl<'self> fmt::Default for Initializer<'self> { + fn fmt(s: &Initializer<'self>, f: &mut fmt::Formatter) { + let tag = if s.contains("\n") { "pre" } else { "code" }; + write!(f.buf, "<{tag}>{}", + s.as_slice(), tag=tag); + } + } + + write!(w, " + + + + + ", + *myitem.name.get_ref(), + s.type_, + Initializer(s.expr), + Markdown(blank(myitem.doc_value()))); + } + + _ => { + write!(w, " + + + + + ", + *myitem.name.get_ref(), + Markdown(shorter(myitem.doc_value())), + class = shortty(myitem), + href = item_path(myitem), + title = full_path(cx, myitem)); + } + } + } + write!(w, "
{}: {} = {}{} 
{}{}
"); +} + +fn item_function(w: &mut io::Writer, it: &clean::Item, f: &clean::Function) { + write!(w, "
{vis}fn {name}{generics}{decl}
", + vis = VisSpace(it.visibility), + name = it.name.get_ref().as_slice(), + generics = f.generics, + decl = f.decl); + document(w, it); +} + +fn item_trait(w: &mut io::Writer, it: &clean::Item, t: &clean::Trait) { + let mut parents = ~""; + if t.parents.len() > 0 { + parents.push_str(": "); + for (i, p) in t.parents.iter().enumerate() { + if i > 0 { parents.push_str(" + "); } + parents.push_str(format!("{}", *p)); + } + } + + // Output the trait definition + write!(w, "
{}trait {}{}{} ",
+           VisSpace(it.visibility),
+           it.name.get_ref().as_slice(),
+           t.generics,
+           parents);
+    let required = t.methods.iter().filter(|m| m.is_req()).to_owned_vec();
+    let provided = t.methods.iter().filter(|m| !m.is_req()).to_owned_vec();
+
+    if t.methods.len() == 0 {
+        write!(w, "\\{ \\}");
+    } else {
+        write!(w, "\\{\n");
+        for m in required.iter() {
+            write!(w, "    ");
+            render_method(w, m.item(), true);
+            write!(w, ";\n");
+        }
+        if required.len() > 0 && provided.len() > 0 {
+            w.write("\n".as_bytes());
+        }
+        for m in provided.iter() {
+            write!(w, "    ");
+            render_method(w, m.item(), true);
+            write!(w, " \\{ ... \\}\n");
+        }
+        write!(w, "\\}");
+    }
+    write!(w, "
"); + + // Trait documentation + document(w, it); + + fn meth(w: &mut io::Writer, m: &clean::TraitMethod) { + write!(w, "

", + *m.item().name.get_ref()); + render_method(w, m.item(), false); + write!(w, "

"); + document(w, m.item()); + } + + // Output the documentation for each function individually + if required.len() > 0 { + write!(w, " +

Required Methods

+
+ "); + for m in required.iter() { + meth(w, *m); + } + write!(w, "
"); + } + if provided.len() > 0 { + write!(w, " +

Provided Methods

+
+ "); + for m in provided.iter() { + meth(w, *m); + } + write!(w, "
"); + } + + do local_data::get(cache_key) |cache| { + do cache.unwrap().read |cache| { + match cache.implementors.find(&it.id) { + Some(implementors) => { + write!(w, " +

Implementors

+
    + "); + for i in implementors.iter() { + match *i { + PathType(ref ty) => { + write!(w, "
  • {}
    • ", *ty); + } + OtherType(ref generics, ref trait_, ref for_) => { + write!(w, "
  • impl{} {} for {}
    • ", + *generics, *trait_, *for_); + } + } + } + write!(w, "
"); + } + None => {} + } + } + } +} + +fn render_method(w: &mut io::Writer, meth: &clean::Item, withlink: bool) { + fn fun(w: &mut io::Writer, it: &clean::Item, purity: ast::purity, + g: &clean::Generics, selfty: &clean::SelfTy, d: &clean::FnDecl, + withlink: bool) { + write!(w, "{}fn {withlink, select, + true{{name}} + other{{name}} + }{generics}{decl}", + match purity { + ast::unsafe_fn => "unsafe ", + _ => "", + }, + name = it.name.get_ref().as_slice(), + generics = *g, + decl = Method(selfty, d), + withlink = if withlink {"true"} else {"false"}); + } + match meth.inner { + clean::TyMethodItem(ref m) => { + fun(w, meth, m.purity, &m.generics, &m.self_, &m.decl, withlink); + } + clean::MethodItem(ref m) => { + fun(w, meth, m.purity, &m.generics, &m.self_, &m.decl, withlink); + } + _ => unreachable!() + } +} + +fn item_struct(w: &mut io::Writer, it: &clean::Item, s: &clean::Struct) { + write!(w, "
");
+    render_struct(w, it, Some(&s.generics), s.struct_type, s.fields, "");
+    write!(w, "
"); + + document(w, it); + render_methods(w, it); +} + +fn item_enum(w: &mut io::Writer, it: &clean::Item, e: &clean::Enum) { + write!(w, "
{}enum {}{}",
+           VisSpace(it.visibility),
+           it.name.get_ref().as_slice(),
+           e.generics);
+    if e.variants.len() == 0 {
+        write!(w, " \\{\\}");
+    } else {
+        write!(w, " \\{\n");
+        for v in e.variants.iter() {
+            let name = v.name.get_ref().as_slice();
+            match v.inner {
+                clean::VariantItem(ref var) => {
+                    match var.kind {
+                        clean::CLikeVariant => write!(w, "    {},\n", name),
+                        clean::TupleVariant(ref tys) => {
+                            write!(w, "    {}(", name);
+                            for (i, ty) in tys.iter().enumerate() {
+                                if i > 0 { write!(w, ", ") }
+                                write!(w, "{}", *ty);
+                            }
+                            write!(w, "),\n");
+                        }
+                        clean::StructVariant(ref s) => {
+                            render_struct(w, v, None, s.struct_type, s.fields,
+                                          "    ");
+                        }
+                    }
+                }
+                _ => unreachable!()
+            }
+        }
+        write!(w, "\\}");
+    }
+    write!(w, "
"); + + document(w, it); + render_methods(w, it); +} + +fn render_struct(w: &mut io::Writer, it: &clean::Item, + g: Option<&clean::Generics>, + ty: doctree::StructType, + fields: &[clean::Item], + tab: &str) { + write!(w, "{}struct {}", + VisSpace(it.visibility), + it.name.get_ref().as_slice()); + match g { + Some(g) => write!(w, "{}", *g), + None => {} + } + match ty { + doctree::Plain => { + write!(w, " \\{\n"); + for field in fields.iter() { + match field.inner { + clean::StructFieldItem(ref ty) => { + write!(w, " {}{}: {},\n{}", + VisSpace(field.visibility), + field.name.get_ref().as_slice(), + ty.type_, + tab); + } + _ => unreachable!() + } + } + write!(w, "\\}"); + } + doctree::Tuple | doctree::Newtype => { + write!(w, "("); + for (i, field) in fields.iter().enumerate() { + if i > 0 { write!(w, ", ") } + match field.inner { + clean::StructFieldItem(ref field) => { + write!(w, "{}", field.type_); + } + _ => unreachable!() + } + } + write!(w, ");"); + } + doctree::Unit => { write!(w, ";"); } + } +} + +fn render_methods(w: &mut io::Writer, it: &clean::Item) { + do local_data::get(cache_key) |cache| { + let cache = cache.unwrap(); + do cache.read |c| { + match c.impls.find(&it.id) { + Some(v) => { + let mut non_trait = v.iter().filter(|i| i.trait_.is_none()); + let non_trait = non_trait.to_owned_vec(); + let mut traits = v.iter().filter(|i| i.trait_.is_some()); + let traits = traits.to_owned_vec(); + + if non_trait.len() > 0 { + write!(w, "

Methods

"); + for &i in non_trait.iter() { + render_impl(w, i); + } + } + if traits.len() > 0 { + write!(w, "

Trait \ + Implementations

"); + for &i in traits.iter() { + render_impl(w, i); + } + } + } + None => {} + } + } + } +} + +fn render_impl(w: &mut io::Writer, i: &clean::Impl) { + write!(w, "

impl{} ", i.generics); + let trait_id = match i.trait_ { + Some(ref ty) => { + write!(w, "{} for ", *ty); + match *ty { + clean::ResolvedPath { id, _ } => Some(id), + _ => None, + } + } + None => None + }; + write!(w, "{}

", i.for_); + write!(w, "
"); + for meth in i.methods.iter() { + write!(w, "

", + *meth.name.get_ref()); + render_method(w, meth, false); + write!(w, "

\n"); + match meth.doc_value() { + Some(s) => { + write!(w, "
{}
", Markdown(s)); + loop + } + None => {} + } + + // No documentation? Attempt to slurp in the trait's documentation + let trait_id = match trait_id { Some(id) => id, None => loop }; + do local_data::get(cache_key) |cache| { + do cache.unwrap().read |cache| { + let name = meth.name.get_ref().as_slice(); + match cache.traits.find(&trait_id) { + Some(m) => { + match m.find_equiv(&name) { + Some(s) => { + write!(w, "
{}
", + Markdown(s.as_slice())); + } + None => {} + } + } + None => {} + } + } + } + } + write!(w, "
"); +} + +fn item_typedef(w: &mut io::Writer, it: &clean::Item, t: &clean::Typedef) { + write!(w, "
type {}{} = {};
", + it.name.get_ref().as_slice(), + t.generics, + t.type_); + + document(w, it); +} + +impl<'self> fmt::Default for Sidebar<'self> { + fn fmt(s: &Sidebar<'self>, fmt: &mut fmt::Formatter) { + let cx = s.cx; + let it = s.item; + write!(fmt.buf, "

"); + let len = cx.current.len() - if it.is_mod() {1} else {0}; + for (i, name) in cx.current.iter().take(len).enumerate() { + if i > 0 { write!(fmt.buf, "&\\#8203;::") } + write!(fmt.buf, "{}", + cx.root_path.slice_to((cx.current.len() - i - 1) * 3), *name); + } + write!(fmt.buf, "

"); + + fn block(w: &mut io::Writer, short: &str, longty: &str, + cur: &clean::Item, cx: &Context) { + let items = match cx.sidebar.find_equiv(&short) { + Some(items) => items.as_slice(), + None => return + }; + write!(w, "

{}

", short, longty); + for item in items.iter() { + let class = if cur.name.get_ref() == item && + short == shortty(cur) { "current" } else { "" }; + write!(w, "{name}
", + ty = short, + class = class, + curty = shortty(cur), + name = item.as_slice()); + } + write!(w, "
"); + } + + block(fmt.buf, "mod", "Modules", it, cx); + block(fmt.buf, "struct", "Structs", it, cx); + block(fmt.buf, "enum", "Enums", it, cx); + block(fmt.buf, "trait", "Traits", it, cx); + block(fmt.buf, "fn", "Functions", it, cx); + } +} + +fn build_sidebar(m: &clean::Module) -> HashMap<~str, ~[~str]> { + let mut map = HashMap::new(); + for item in m.items.iter() { + let short = shortty(item); + let myname = match item.name { + None => loop, + Some(ref s) => s.to_owned(), + }; + let v = map.find_or_insert_with(short.to_owned(), |_| ~[]); + v.push(myname); + } + + for (_, items) in map.mut_iter() { + sort::quick_sort(*items, |i1, i2| i1 < i2); + } + return map; +} diff --git a/src/librustdoc/html/static/jquery-2.0.3.min.js b/src/librustdoc/html/static/jquery-2.0.3.min.js new file mode 100644 index 00000000000..2be209dd223 --- /dev/null +++ b/src/librustdoc/html/static/jquery-2.0.3.min.js @@ -0,0 +1,6 @@ +/*! jQuery v2.0.3 | (c) 2005, 2013 jQuery Foundation, Inc. | jquery.org/license +//@ sourceMappingURL=jquery-2.0.3.min.map +*/ +(function(e,undefined){var t,n,r=typeof undefined,i=e.location,o=e.document,s=o.documentElement,a=e.jQuery,u=e.$,l={},c=[],p="2.0.3",f=c.concat,h=c.push,d=c.slice,g=c.indexOf,m=l.toString,y=l.hasOwnProperty,v=p.trim,x=function(e,n){return new x.fn.init(e,n,t)},b=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,w=/\S+/g,T=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,C=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,k=/^-ms-/,N=/-([\da-z])/gi,E=function(e,t){return t.toUpperCase()},S=function(){o.removeEventListener("DOMContentLoaded",S,!1),e.removeEventListener("load",S,!1),x.ready()};x.fn=x.prototype={jquery:p,constructor:x,init:function(e,t,n){var r,i;if(!e)return this;if("string"==typeof e){if(r="<"===e.charAt(0)&&">"===e.charAt(e.length-1)&&e.length>=3?[null,e,null]:T.exec(e),!r||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof x?t[0]:t,x.merge(this,x.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:o,!0)),C.test(r[1])&&x.isPlainObject(t))for(r in t)x.isFunction(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return i=o.getElementById(r[2]),i&&i.parentNode&&(this.length=1,this[0]=i),this.context=o,this.selector=e,this}return e.nodeType?(this.context=this[0]=e,this.length=1,this):x.isFunction(e)?n.ready(e):(e.selector!==undefined&&(this.selector=e.selector,this.context=e.context),x.makeArray(e,this))},selector:"",length:0,toArray:function(){return d.call(this)},get:function(e){return null==e?this.toArray():0>e?this[this.length+e]:this[e]},pushStack:function(e){var t=x.merge(this.constructor(),e);return t.prevObject=this,t.context=this.context,t},each:function(e,t){return x.each(this,e,t)},ready:function(e){return x.ready.promise().done(e),this},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(e){var t=this.length,n=+e+(0>e?t:0);return this.pushStack(n>=0&&t>n?[this[n]]:[])},map:function(e){return this.pushStack(x.map(this,function(t,n){return e.call(t,n,t)}))},end:function(){return this.prevObject||this.constructor(null)},push:h,sort:[].sort,splice:[].splice},x.fn.init.prototype=x.fn,x.extend=x.fn.extend=function(){var e,t,n,r,i,o,s=arguments[0]||{},a=1,u=arguments.length,l=!1;for("boolean"==typeof s&&(l=s,s=arguments[1]||{},a=2),"object"==typeof s||x.isFunction(s)||(s={}),u===a&&(s=this,--a);u>a;a++)if(null!=(e=arguments[a]))for(t in e)n=s[t],r=e[t],s!==r&&(l&&r&&(x.isPlainObject(r)||(i=x.isArray(r)))?(i?(i=!1,o=n&&x.isArray(n)?n:[]):o=n&&x.isPlainObject(n)?n:{},s[t]=x.extend(l,o,r)):r!==undefined&&(s[t]=r));return s},x.extend({expando:"jQuery"+(p+Math.random()).replace(/\D/g,""),noConflict:function(t){return e.$===x&&(e.$=u),t&&e.jQuery===x&&(e.jQuery=a),x},isReady:!1,readyWait:1,holdReady:function(e){e?x.readyWait++:x.ready(!0)},ready:function(e){(e===!0?--x.readyWait:x.isReady)||(x.isReady=!0,e!==!0&&--x.readyWait>0||(n.resolveWith(o,[x]),x.fn.trigger&&x(o).trigger("ready").off("ready")))},isFunction:function(e){return"function"===x.type(e)},isArray:Array.isArray,isWindow:function(e){return null!=e&&e===e.window},isNumeric:function(e){return!isNaN(parseFloat(e))&&isFinite(e)},type:function(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?l[m.call(e)]||"object":typeof e},isPlainObject:function(e){if("object"!==x.type(e)||e.nodeType||x.isWindow(e))return!1;try{if(e.constructor&&!y.call(e.constructor.prototype,"isPrototypeOf"))return!1}catch(t){return!1}return!0},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},error:function(e){throw Error(e)},parseHTML:function(e,t,n){if(!e||"string"!=typeof e)return null;"boolean"==typeof t&&(n=t,t=!1),t=t||o;var r=C.exec(e),i=!n&&[];return r?[t.createElement(r[1])]:(r=x.buildFragment([e],t,i),i&&x(i).remove(),x.merge([],r.childNodes))},parseJSON:JSON.parse,parseXML:function(e){var t,n;if(!e||"string"!=typeof e)return null;try{n=new DOMParser,t=n.parseFromString(e,"text/xml")}catch(r){t=undefined}return(!t||t.getElementsByTagName("parsererror").length)&&x.error("Invalid XML: "+e),t},noop:function(){},globalEval:function(e){var t,n=eval;e=x.trim(e),e&&(1===e.indexOf("use strict")?(t=o.createElement("script"),t.text=e,o.head.appendChild(t).parentNode.removeChild(t)):n(e))},camelCase:function(e){return e.replace(k,"ms-").replace(N,E)},nodeName:function(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()},each:function(e,t,n){var r,i=0,o=e.length,s=j(e);if(n){if(s){for(;o>i;i++)if(r=t.apply(e[i],n),r===!1)break}else for(i in e)if(r=t.apply(e[i],n),r===!1)break}else if(s){for(;o>i;i++)if(r=t.call(e[i],i,e[i]),r===!1)break}else for(i in e)if(r=t.call(e[i],i,e[i]),r===!1)break;return e},trim:function(e){return null==e?"":v.call(e)},makeArray:function(e,t){var n=t||[];return null!=e&&(j(Object(e))?x.merge(n,"string"==typeof e?[e]:e):h.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:g.call(t,e,n)},merge:function(e,t){var n=t.length,r=e.length,i=0;if("number"==typeof n)for(;n>i;i++)e[r++]=t[i];else while(t[i]!==undefined)e[r++]=t[i++];return e.length=r,e},grep:function(e,t,n){var r,i=[],o=0,s=e.length;for(n=!!n;s>o;o++)r=!!t(e[o],o),n!==r&&i.push(e[o]);return i},map:function(e,t,n){var r,i=0,o=e.length,s=j(e),a=[];if(s)for(;o>i;i++)r=t(e[i],i,n),null!=r&&(a[a.length]=r);else for(i in e)r=t(e[i],i,n),null!=r&&(a[a.length]=r);return f.apply([],a)},guid:1,proxy:function(e,t){var n,r,i;return"string"==typeof t&&(n=e[t],t=e,e=n),x.isFunction(e)?(r=d.call(arguments,2),i=function(){return e.apply(t||this,r.concat(d.call(arguments)))},i.guid=e.guid=e.guid||x.guid++,i):undefined},access:function(e,t,n,r,i,o,s){var a=0,u=e.length,l=null==n;if("object"===x.type(n)){i=!0;for(a in n)x.access(e,t,a,n[a],!0,o,s)}else if(r!==undefined&&(i=!0,x.isFunction(r)||(s=!0),l&&(s?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(x(e),n)})),t))for(;u>a;a++)t(e[a],n,s?r:r.call(e[a],a,t(e[a],n)));return i?e:l?t.call(e):u?t(e[0],n):o},now:Date.now,swap:function(e,t,n,r){var i,o,s={};for(o in t)s[o]=e.style[o],e.style[o]=t[o];i=n.apply(e,r||[]);for(o in t)e.style[o]=s[o];return i}}),x.ready.promise=function(t){return n||(n=x.Deferred(),"complete"===o.readyState?setTimeout(x.ready):(o.addEventListener("DOMContentLoaded",S,!1),e.addEventListener("load",S,!1))),n.promise(t)},x.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(e,t){l["[object "+t+"]"]=t.toLowerCase()});function j(e){var t=e.length,n=x.type(e);return x.isWindow(e)?!1:1===e.nodeType&&t?!0:"array"===n||"function"!==n&&(0===t||"number"==typeof t&&t>0&&t-1 in e)}t=x(o),function(e,undefined){var t,n,r,i,o,s,a,u,l,c,p,f,h,d,g,m,y,v="sizzle"+-new Date,b=e.document,w=0,T=0,C=st(),k=st(),N=st(),E=!1,S=function(e,t){return e===t?(E=!0,0):0},j=typeof undefined,D=1<<31,A={}.hasOwnProperty,L=[],q=L.pop,H=L.push,O=L.push,F=L.slice,P=L.indexOf||function(e){var t=0,n=this.length;for(;n>t;t++)if(this[t]===e)return t;return-1},R="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",W="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",$=W.replace("w","w#"),B="\\["+M+"*("+W+")"+M+"*(?:([*^$|!~]?=)"+M+"*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|("+$+")|)|)"+M+"*\\]",I=":("+W+")(?:\\(((['\"])((?:\\\\.|[^\\\\])*?)\\3|((?:\\\\.|[^\\\\()[\\]]|"+B.replace(3,8)+")*)|.*)\\)|)",z=RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),_=RegExp("^"+M+"*,"+M+"*"),X=RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=RegExp(M+"*[+~]"),Y=RegExp("="+M+"*([^\\]'\"]*)"+M+"*\\]","g"),V=RegExp(I),G=RegExp("^"+$+"$"),J={ID:RegExp("^#("+W+")"),CLASS:RegExp("^\\.("+W+")"),TAG:RegExp("^("+W.replace("w","w*")+")"),ATTR:RegExp("^"+B),PSEUDO:RegExp("^"+I),CHILD:RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:RegExp("^(?:"+R+")$","i"),needsContext:RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Q=/^[^{]+\{\s*\[native \w/,K=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,Z=/^(?:input|select|textarea|button)$/i,et=/^h\d$/i,tt=/'|\\/g,nt=RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),rt=function(e,t,n){var r="0x"+t-65536;return r!==r||n?t:0>r?String.fromCharCode(r+65536):String.fromCharCode(55296|r>>10,56320|1023&r)};try{O.apply(L=F.call(b.childNodes),b.childNodes),L[b.childNodes.length].nodeType}catch(it){O={apply:L.length?function(e,t){H.apply(e,F.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function ot(e,t,r,i){var o,s,a,u,l,f,g,m,x,w;if((t?t.ownerDocument||t:b)!==p&&c(t),t=t||p,r=r||[],!e||"string"!=typeof e)return r;if(1!==(u=t.nodeType)&&9!==u)return[];if(h&&!i){if(o=K.exec(e))if(a=o[1]){if(9===u){if(s=t.getElementById(a),!s||!s.parentNode)return r;if(s.id===a)return r.push(s),r}else if(t.ownerDocument&&(s=t.ownerDocument.getElementById(a))&&y(t,s)&&s.id===a)return r.push(s),r}else{if(o[2])return O.apply(r,t.getElementsByTagName(e)),r;if((a=o[3])&&n.getElementsByClassName&&t.getElementsByClassName)return O.apply(r,t.getElementsByClassName(a)),r}if(n.qsa&&(!d||!d.test(e))){if(m=g=v,x=t,w=9===u&&e,1===u&&"object"!==t.nodeName.toLowerCase()){f=gt(e),(g=t.getAttribute("id"))?m=g.replace(tt,"\\$&"):t.setAttribute("id",m),m="[id='"+m+"'] ",l=f.length;while(l--)f[l]=m+mt(f[l]);x=U.test(e)&&t.parentNode||t,w=f.join(",")}if(w)try{return O.apply(r,x.querySelectorAll(w)),r}catch(T){}finally{g||t.removeAttribute("id")}}}return kt(e.replace(z,"$1"),t,r,i)}function st(){var e=[];function t(n,r){return e.push(n+=" ")>i.cacheLength&&delete t[e.shift()],t[n]=r}return t}function at(e){return e[v]=!0,e}function ut(e){var t=p.createElement("div");try{return!!e(t)}catch(n){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function lt(e,t){var n=e.split("|"),r=e.length;while(r--)i.attrHandle[n[r]]=t}function ct(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&(~t.sourceIndex||D)-(~e.sourceIndex||D);if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function pt(e){return function(t){var n=t.nodeName.toLowerCase();return"input"===n&&t.type===e}}function ft(e){return function(t){var n=t.nodeName.toLowerCase();return("input"===n||"button"===n)&&t.type===e}}function ht(e){return at(function(t){return t=+t,at(function(n,r){var i,o=e([],n.length,t),s=o.length;while(s--)n[i=o[s]]&&(n[i]=!(r[i]=n[i]))})})}s=ot.isXML=function(e){var t=e&&(e.ownerDocument||e).documentElement;return t?"HTML"!==t.nodeName:!1},n=ot.support={},c=ot.setDocument=function(e){var t=e?e.ownerDocument||e:b,r=t.defaultView;return t!==p&&9===t.nodeType&&t.documentElement?(p=t,f=t.documentElement,h=!s(t),r&&r.attachEvent&&r!==r.top&&r.attachEvent("onbeforeunload",function(){c()}),n.attributes=ut(function(e){return e.className="i",!e.getAttribute("className")}),n.getElementsByTagName=ut(function(e){return e.appendChild(t.createComment("")),!e.getElementsByTagName("*").length}),n.getElementsByClassName=ut(function(e){return e.innerHTML="
",e.firstChild.className="i",2===e.getElementsByClassName("i").length}),n.getById=ut(function(e){return f.appendChild(e).id=v,!t.getElementsByName||!t.getElementsByName(v).length}),n.getById?(i.find.ID=function(e,t){if(typeof t.getElementById!==j&&h){var n=t.getElementById(e);return n&&n.parentNode?[n]:[]}},i.filter.ID=function(e){var t=e.replace(nt,rt);return function(e){return e.getAttribute("id")===t}}):(delete i.find.ID,i.filter.ID=function(e){var t=e.replace(nt,rt);return function(e){var n=typeof e.getAttributeNode!==j&&e.getAttributeNode("id");return n&&n.value===t}}),i.find.TAG=n.getElementsByTagName?function(e,t){return typeof t.getElementsByTagName!==j?t.getElementsByTagName(e):undefined}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},i.find.CLASS=n.getElementsByClassName&&function(e,t){return typeof t.getElementsByClassName!==j&&h?t.getElementsByClassName(e):undefined},g=[],d=[],(n.qsa=Q.test(t.querySelectorAll))&&(ut(function(e){e.innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll(":checked").length||d.push(":checked")}),ut(function(e){var n=t.createElement("input");n.setAttribute("type","hidden"),e.appendChild(n).setAttribute("t",""),e.querySelectorAll("[t^='']").length&&d.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll(":enabled").length||d.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),d.push(",.*:")})),(n.matchesSelector=Q.test(m=f.webkitMatchesSelector||f.mozMatchesSelector||f.oMatchesSelector||f.msMatchesSelector))&&ut(function(e){n.disconnectedMatch=m.call(e,"div"),m.call(e,"[s!='']:x"),g.push("!=",I)}),d=d.length&&RegExp(d.join("|")),g=g.length&&RegExp(g.join("|")),y=Q.test(f.contains)||f.compareDocumentPosition?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},S=f.compareDocumentPosition?function(e,r){if(e===r)return E=!0,0;var i=r.compareDocumentPosition&&e.compareDocumentPosition&&e.compareDocumentPosition(r);return i?1&i||!n.sortDetached&&r.compareDocumentPosition(e)===i?e===t||y(b,e)?-1:r===t||y(b,r)?1:l?P.call(l,e)-P.call(l,r):0:4&i?-1:1:e.compareDocumentPosition?-1:1}:function(e,n){var r,i=0,o=e.parentNode,s=n.parentNode,a=[e],u=[n];if(e===n)return E=!0,0;if(!o||!s)return e===t?-1:n===t?1:o?-1:s?1:l?P.call(l,e)-P.call(l,n):0;if(o===s)return ct(e,n);r=e;while(r=r.parentNode)a.unshift(r);r=n;while(r=r.parentNode)u.unshift(r);while(a[i]===u[i])i++;return i?ct(a[i],u[i]):a[i]===b?-1:u[i]===b?1:0},t):p},ot.matches=function(e,t){return ot(e,null,null,t)},ot.matchesSelector=function(e,t){if((e.ownerDocument||e)!==p&&c(e),t=t.replace(Y,"='$1']"),!(!n.matchesSelector||!h||g&&g.test(t)||d&&d.test(t)))try{var r=m.call(e,t);if(r||n.disconnectedMatch||e.document&&11!==e.document.nodeType)return r}catch(i){}return ot(t,p,null,[e]).length>0},ot.contains=function(e,t){return(e.ownerDocument||e)!==p&&c(e),y(e,t)},ot.attr=function(e,t){(e.ownerDocument||e)!==p&&c(e);var r=i.attrHandle[t.toLowerCase()],o=r&&A.call(i.attrHandle,t.toLowerCase())?r(e,t,!h):undefined;return o===undefined?n.attributes||!h?e.getAttribute(t):(o=e.getAttributeNode(t))&&o.specified?o.value:null:o},ot.error=function(e){throw Error("Syntax error, unrecognized expression: "+e)},ot.uniqueSort=function(e){var t,r=[],i=0,o=0;if(E=!n.detectDuplicates,l=!n.sortStable&&e.slice(0),e.sort(S),E){while(t=e[o++])t===e[o]&&(i=r.push(o));while(i--)e.splice(r[i],1)}return e},o=ot.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=o(e)}else if(3===i||4===i)return e.nodeValue}else for(;t=e[r];r++)n+=o(t);return n},i=ot.selectors={cacheLength:50,createPseudo:at,match:J,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(nt,rt),e[3]=(e[4]||e[5]||"").replace(nt,rt),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||ot.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&ot.error(e[0]),e},PSEUDO:function(e){var t,n=!e[5]&&e[2];return J.CHILD.test(e[0])?null:(e[3]&&e[4]!==undefined?e[2]=e[4]:n&&V.test(n)&&(t=gt(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(nt,rt).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=C[e+" "];return t||(t=RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&C(e,function(e){return t.test("string"==typeof e.className&&e.className||typeof e.getAttribute!==j&&e.getAttribute("class")||"")})},ATTR:function(e,t,n){return function(r){var i=ot.attr(r,e);return null==i?"!="===t:t?(i+="","="===t?i===n:"!="===t?i!==n:"^="===t?n&&0===i.indexOf(n):"*="===t?n&&i.indexOf(n)>-1:"$="===t?n&&i.slice(-n.length)===n:"~="===t?(" "+i+" ").indexOf(n)>-1:"|="===t?i===n||i.slice(0,n.length+1)===n+"-":!1):!0}},CHILD:function(e,t,n,r,i){var o="nth"!==e.slice(0,3),s="last"!==e.slice(-4),a="of-type"===t;return 1===r&&0===i?function(e){return!!e.parentNode}:function(t,n,u){var l,c,p,f,h,d,g=o!==s?"nextSibling":"previousSibling",m=t.parentNode,y=a&&t.nodeName.toLowerCase(),x=!u&&!a;if(m){if(o){while(g){p=t;while(p=p[g])if(a?p.nodeName.toLowerCase()===y:1===p.nodeType)return!1;d=g="only"===e&&!d&&"nextSibling"}return!0}if(d=[s?m.firstChild:m.lastChild],s&&x){c=m[v]||(m[v]={}),l=c[e]||[],h=l[0]===w&&l[1],f=l[0]===w&&l[2],p=h&&m.childNodes[h];while(p=++h&&p&&p[g]||(f=h=0)||d.pop())if(1===p.nodeType&&++f&&p===t){c[e]=[w,h,f];break}}else if(x&&(l=(t[v]||(t[v]={}))[e])&&l[0]===w)f=l[1];else while(p=++h&&p&&p[g]||(f=h=0)||d.pop())if((a?p.nodeName.toLowerCase()===y:1===p.nodeType)&&++f&&(x&&((p[v]||(p[v]={}))[e]=[w,f]),p===t))break;return f-=i,f===r||0===f%r&&f/r>=0}}},PSEUDO:function(e,t){var n,r=i.pseudos[e]||i.setFilters[e.toLowerCase()]||ot.error("unsupported pseudo: "+e);return r[v]?r(t):r.length>1?(n=[e,e,"",t],i.setFilters.hasOwnProperty(e.toLowerCase())?at(function(e,n){var i,o=r(e,t),s=o.length;while(s--)i=P.call(e,o[s]),e[i]=!(n[i]=o[s])}):function(e){return r(e,0,n)}):r}},pseudos:{not:at(function(e){var t=[],n=[],r=a(e.replace(z,"$1"));return r[v]?at(function(e,t,n,i){var o,s=r(e,null,i,[]),a=e.length;while(a--)(o=s[a])&&(e[a]=!(t[a]=o))}):function(e,i,o){return t[0]=e,r(t,null,o,n),!n.pop()}}),has:at(function(e){return function(t){return ot(e,t).length>0}}),contains:at(function(e){return function(t){return(t.textContent||t.innerText||o(t)).indexOf(e)>-1}}),lang:at(function(e){return G.test(e||"")||ot.error("unsupported lang: "+e),e=e.replace(nt,rt).toLowerCase(),function(t){var n;do if(n=h?t.lang:t.getAttribute("xml:lang")||t.getAttribute("lang"))return n=n.toLowerCase(),n===e||0===n.indexOf(e+"-");while((t=t.parentNode)&&1===t.nodeType);return!1}}),target:function(t){var n=e.location&&e.location.hash;return n&&n.slice(1)===t.id},root:function(e){return e===f},focus:function(e){return e===p.activeElement&&(!p.hasFocus||p.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:function(e){return e.disabled===!1},disabled:function(e){return e.disabled===!0},checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,e.selected===!0},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeName>"@"||3===e.nodeType||4===e.nodeType)return!1;return!0},parent:function(e){return!i.pseudos.empty(e)},header:function(e){return et.test(e.nodeName)},input:function(e){return Z.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||t.toLowerCase()===e.type)},first:ht(function(){return[0]}),last:ht(function(e,t){return[t-1]}),eq:ht(function(e,t,n){return[0>n?n+t:n]}),even:ht(function(e,t){var n=0;for(;t>n;n+=2)e.push(n);return e}),odd:ht(function(e,t){var n=1;for(;t>n;n+=2)e.push(n);return e}),lt:ht(function(e,t,n){var r=0>n?n+t:n;for(;--r>=0;)e.push(r);return e}),gt:ht(function(e,t,n){var r=0>n?n+t:n;for(;t>++r;)e.push(r);return e})}},i.pseudos.nth=i.pseudos.eq;for(t in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})i.pseudos[t]=pt(t);for(t in{submit:!0,reset:!0})i.pseudos[t]=ft(t);function dt(){}dt.prototype=i.filters=i.pseudos,i.setFilters=new dt;function gt(e,t){var n,r,o,s,a,u,l,c=k[e+" "];if(c)return t?0:c.slice(0);a=e,u=[],l=i.preFilter;while(a){(!n||(r=_.exec(a)))&&(r&&(a=a.slice(r[0].length)||a),u.push(o=[])),n=!1,(r=X.exec(a))&&(n=r.shift(),o.push({value:n,type:r[0].replace(z," ")}),a=a.slice(n.length));for(s in i.filter)!(r=J[s].exec(a))||l[s]&&!(r=l[s](r))||(n=r.shift(),o.push({value:n,type:s,matches:r}),a=a.slice(n.length));if(!n)break}return t?a.length:a?ot.error(e):k(e,u).slice(0)}function mt(e){var t=0,n=e.length,r="";for(;n>t;t++)r+=e[t].value;return r}function yt(e,t,n){var i=t.dir,o=n&&"parentNode"===i,s=T++;return t.first?function(t,n,r){while(t=t[i])if(1===t.nodeType||o)return e(t,n,r)}:function(t,n,a){var u,l,c,p=w+" "+s;if(a){while(t=t[i])if((1===t.nodeType||o)&&e(t,n,a))return!0}else while(t=t[i])if(1===t.nodeType||o)if(c=t[v]||(t[v]={}),(l=c[i])&&l[0]===p){if((u=l[1])===!0||u===r)return u===!0}else if(l=c[i]=[p],l[1]=e(t,n,a)||r,l[1]===!0)return!0}}function vt(e){return e.length>1?function(t,n,r){var i=e.length;while(i--)if(!e[i](t,n,r))return!1;return!0}:e[0]}function xt(e,t,n,r,i){var o,s=[],a=0,u=e.length,l=null!=t;for(;u>a;a++)(o=e[a])&&(!n||n(o,r,i))&&(s.push(o),l&&t.push(a));return s}function bt(e,t,n,r,i,o){return r&&!r[v]&&(r=bt(r)),i&&!i[v]&&(i=bt(i,o)),at(function(o,s,a,u){var l,c,p,f=[],h=[],d=s.length,g=o||Ct(t||"*",a.nodeType?[a]:a,[]),m=!e||!o&&t?g:xt(g,f,e,a,u),y=n?i||(o?e:d||r)?[]:s:m;if(n&&n(m,y,a,u),r){l=xt(y,h),r(l,[],a,u),c=l.length;while(c--)(p=l[c])&&(y[h[c]]=!(m[h[c]]=p))}if(o){if(i||e){if(i){l=[],c=y.length;while(c--)(p=y[c])&&l.push(m[c]=p);i(null,y=[],l,u)}c=y.length;while(c--)(p=y[c])&&(l=i?P.call(o,p):f[c])>-1&&(o[l]=!(s[l]=p))}}else y=xt(y===s?y.splice(d,y.length):y),i?i(null,s,y,u):O.apply(s,y)})}function wt(e){var t,n,r,o=e.length,s=i.relative[e[0].type],a=s||i.relative[" "],l=s?1:0,c=yt(function(e){return e===t},a,!0),p=yt(function(e){return P.call(t,e)>-1},a,!0),f=[function(e,n,r){return!s&&(r||n!==u)||((t=n).nodeType?c(e,n,r):p(e,n,r))}];for(;o>l;l++)if(n=i.relative[e[l].type])f=[yt(vt(f),n)];else{if(n=i.filter[e[l].type].apply(null,e[l].matches),n[v]){for(r=++l;o>r;r++)if(i.relative[e[r].type])break;return bt(l>1&&vt(f),l>1&&mt(e.slice(0,l-1).concat({value:" "===e[l-2].type?"*":""})).replace(z,"$1"),n,r>l&&wt(e.slice(l,r)),o>r&&wt(e=e.slice(r)),o>r&&mt(e))}f.push(n)}return vt(f)}function Tt(e,t){var n=0,o=t.length>0,s=e.length>0,a=function(a,l,c,f,h){var d,g,m,y=[],v=0,x="0",b=a&&[],T=null!=h,C=u,k=a||s&&i.find.TAG("*",h&&l.parentNode||l),N=w+=null==C?1:Math.random()||.1;for(T&&(u=l!==p&&l,r=n);null!=(d=k[x]);x++){if(s&&d){g=0;while(m=e[g++])if(m(d,l,c)){f.push(d);break}T&&(w=N,r=++n)}o&&((d=!m&&d)&&v--,a&&b.push(d))}if(v+=x,o&&x!==v){g=0;while(m=t[g++])m(b,y,l,c);if(a){if(v>0)while(x--)b[x]||y[x]||(y[x]=q.call(f));y=xt(y)}O.apply(f,y),T&&!a&&y.length>0&&v+t.length>1&&ot.uniqueSort(f)}return T&&(w=N,u=C),b};return o?at(a):a}a=ot.compile=function(e,t){var n,r=[],i=[],o=N[e+" "];if(!o){t||(t=gt(e)),n=t.length;while(n--)o=wt(t[n]),o[v]?r.push(o):i.push(o);o=N(e,Tt(i,r))}return o};function Ct(e,t,n){var r=0,i=t.length;for(;i>r;r++)ot(e,t[r],n);return n}function kt(e,t,r,o){var s,u,l,c,p,f=gt(e);if(!o&&1===f.length){if(u=f[0]=f[0].slice(0),u.length>2&&"ID"===(l=u[0]).type&&n.getById&&9===t.nodeType&&h&&i.relative[u[1].type]){if(t=(i.find.ID(l.matches[0].replace(nt,rt),t)||[])[0],!t)return r;e=e.slice(u.shift().value.length)}s=J.needsContext.test(e)?0:u.length;while(s--){if(l=u[s],i.relative[c=l.type])break;if((p=i.find[c])&&(o=p(l.matches[0].replace(nt,rt),U.test(u[0].type)&&t.parentNode||t))){if(u.splice(s,1),e=o.length&&mt(u),!e)return O.apply(r,o),r;break}}}return a(e,f)(o,t,!h,r,U.test(e)),r}n.sortStable=v.split("").sort(S).join("")===v,n.detectDuplicates=E,c(),n.sortDetached=ut(function(e){return 1&e.compareDocumentPosition(p.createElement("div"))}),ut(function(e){return e.innerHTML="","#"===e.firstChild.getAttribute("href")})||lt("type|href|height|width",function(e,t,n){return n?undefined:e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),n.attributes&&ut(function(e){return e.innerHTML="",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||lt("value",function(e,t,n){return n||"input"!==e.nodeName.toLowerCase()?undefined:e.defaultValue}),ut(function(e){return null==e.getAttribute("disabled")})||lt(R,function(e,t,n){var r;return n?undefined:(r=e.getAttributeNode(t))&&r.specified?r.value:e[t]===!0?t.toLowerCase():null}),x.find=ot,x.expr=ot.selectors,x.expr[":"]=x.expr.pseudos,x.unique=ot.uniqueSort,x.text=ot.getText,x.isXMLDoc=ot.isXML,x.contains=ot.contains}(e);var D={};function A(e){var t=D[e]={};return x.each(e.match(w)||[],function(e,n){t[n]=!0}),t}x.Callbacks=function(e){e="string"==typeof e?D[e]||A(e):x.extend({},e);var t,n,r,i,o,s,a=[],u=!e.once&&[],l=function(p){for(t=e.memory&&p,n=!0,s=i||0,i=0,o=a.length,r=!0;a&&o>s;s++)if(a[s].apply(p[0],p[1])===!1&&e.stopOnFalse){t=!1;break}r=!1,a&&(u?u.length&&l(u.shift()):t?a=[]:c.disable())},c={add:function(){if(a){var n=a.length;(function s(t){x.each(t,function(t,n){var r=x.type(n);"function"===r?e.unique&&c.has(n)||a.push(n):n&&n.length&&"string"!==r&&s(n)})})(arguments),r?o=a.length:t&&(i=n,l(t))}return this},remove:function(){return a&&x.each(arguments,function(e,t){var n;while((n=x.inArray(t,a,n))>-1)a.splice(n,1),r&&(o>=n&&o--,s>=n&&s--)}),this},has:function(e){return e?x.inArray(e,a)>-1:!(!a||!a.length)},empty:function(){return a=[],o=0,this},disable:function(){return a=u=t=undefined,this},disabled:function(){return!a},lock:function(){return u=undefined,t||c.disable(),this},locked:function(){return!u},fireWith:function(e,t){return!a||n&&!u||(t=t||[],t=[e,t.slice?t.slice():t],r?u.push(t):l(t)),this},fire:function(){return c.fireWith(this,arguments),this},fired:function(){return!!n}};return c},x.extend({Deferred:function(e){var t=[["resolve","done",x.Callbacks("once memory"),"resolved"],["reject","fail",x.Callbacks("once memory"),"rejected"],["notify","progress",x.Callbacks("memory")]],n="pending",r={state:function(){return n},always:function(){return i.done(arguments).fail(arguments),this},then:function(){var e=arguments;return x.Deferred(function(n){x.each(t,function(t,o){var s=o[0],a=x.isFunction(e[t])&&e[t];i[o[1]](function(){var e=a&&a.apply(this,arguments);e&&x.isFunction(e.promise)?e.promise().done(n.resolve).fail(n.reject).progress(n.notify):n[s+"With"](this===r?n.promise():this,a?[e]:arguments)})}),e=null}).promise()},promise:function(e){return null!=e?x.extend(e,r):r}},i={};return r.pipe=r.then,x.each(t,function(e,o){var s=o[2],a=o[3];r[o[1]]=s.add,a&&s.add(function(){n=a},t[1^e][2].disable,t[2][2].lock),i[o[0]]=function(){return i[o[0]+"With"](this===i?r:this,arguments),this},i[o[0]+"With"]=s.fireWith}),r.promise(i),e&&e.call(i,i),i},when:function(e){var t=0,n=d.call(arguments),r=n.length,i=1!==r||e&&x.isFunction(e.promise)?r:0,o=1===i?e:x.Deferred(),s=function(e,t,n){return function(r){t[e]=this,n[e]=arguments.length>1?d.call(arguments):r,n===a?o.notifyWith(t,n):--i||o.resolveWith(t,n)}},a,u,l;if(r>1)for(a=Array(r),u=Array(r),l=Array(r);r>t;t++)n[t]&&x.isFunction(n[t].promise)?n[t].promise().done(s(t,l,n)).fail(o.reject).progress(s(t,u,a)):--i;return i||o.resolveWith(l,n),o.promise()}}),x.support=function(t){var n=o.createElement("input"),r=o.createDocumentFragment(),i=o.createElement("div"),s=o.createElement("select"),a=s.appendChild(o.createElement("option"));return n.type?(n.type="checkbox",t.checkOn=""!==n.value,t.optSelected=a.selected,t.reliableMarginRight=!0,t.boxSizingReliable=!0,t.pixelPosition=!1,n.checked=!0,t.noCloneChecked=n.cloneNode(!0).checked,s.disabled=!0,t.optDisabled=!a.disabled,n=o.createElement("input"),n.value="t",n.type="radio",t.radioValue="t"===n.value,n.setAttribute("checked","t"),n.setAttribute("name","t"),r.appendChild(n),t.checkClone=r.cloneNode(!0).cloneNode(!0).lastChild.checked,t.focusinBubbles="onfocusin"in e,i.style.backgroundClip="content-box",i.cloneNode(!0).style.backgroundClip="",t.clearCloneStyle="content-box"===i.style.backgroundClip,x(function(){var n,r,s="padding:0;margin:0;border:0;display:block;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box",a=o.getElementsByTagName("body")[0];a&&(n=o.createElement("div"),n.style.cssText="border:0;width:0;height:0;position:absolute;top:0;left:-9999px;margin-top:1px",a.appendChild(n).appendChild(i),i.innerHTML="",i.style.cssText="-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:1px;border:1px;display:block;width:4px;margin-top:1%;position:absolute;top:1%",x.swap(a,null!=a.style.zoom?{zoom:1}:{},function(){t.boxSizing=4===i.offsetWidth}),e.getComputedStyle&&(t.pixelPosition="1%"!==(e.getComputedStyle(i,null)||{}).top,t.boxSizingReliable="4px"===(e.getComputedStyle(i,null)||{width:"4px"}).width,r=i.appendChild(o.createElement("div")),r.style.cssText=i.style.cssText=s,r.style.marginRight=r.style.width="0",i.style.width="1px",t.reliableMarginRight=!parseFloat((e.getComputedStyle(r,null)||{}).marginRight)),a.removeChild(n))}),t):t}({});var L,q,H=/(?:\{[\s\S]*\}|\[[\s\S]*\])$/,O=/([A-Z])/g;function F(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=x.expando+Math.random()}F.uid=1,F.accepts=function(e){return e.nodeType?1===e.nodeType||9===e.nodeType:!0},F.prototype={key:function(e){if(!F.accepts(e))return 0;var t={},n=e[this.expando];if(!n){n=F.uid++;try{t[this.expando]={value:n},Object.defineProperties(e,t)}catch(r){t[this.expando]=n,x.extend(e,t)}}return this.cache[n]||(this.cache[n]={}),n},set:function(e,t,n){var r,i=this.key(e),o=this.cache[i];if("string"==typeof t)o[t]=n;else if(x.isEmptyObject(o))x.extend(this.cache[i],t);else for(r in t)o[r]=t[r];return o},get:function(e,t){var n=this.cache[this.key(e)];return t===undefined?n:n[t]},access:function(e,t,n){var r;return t===undefined||t&&"string"==typeof t&&n===undefined?(r=this.get(e,t),r!==undefined?r:this.get(e,x.camelCase(t))):(this.set(e,t,n),n!==undefined?n:t)},remove:function(e,t){var n,r,i,o=this.key(e),s=this.cache[o];if(t===undefined)this.cache[o]={};else{x.isArray(t)?r=t.concat(t.map(x.camelCase)):(i=x.camelCase(t),t in s?r=[t,i]:(r=i,r=r in s?[r]:r.match(w)||[])),n=r.length;while(n--)delete s[r[n]]}},hasData:function(e){return!x.isEmptyObject(this.cache[e[this.expando]]||{})},discard:function(e){e[this.expando]&&delete this.cache[e[this.expando]]}},L=new F,q=new F,x.extend({acceptData:F.accepts,hasData:function(e){return L.hasData(e)||q.hasData(e)},data:function(e,t,n){return L.access(e,t,n)},removeData:function(e,t){L.remove(e,t)},_data:function(e,t,n){return q.access(e,t,n)},_removeData:function(e,t){q.remove(e,t)}}),x.fn.extend({data:function(e,t){var n,r,i=this[0],o=0,s=null;if(e===undefined){if(this.length&&(s=L.get(i),1===i.nodeType&&!q.get(i,"hasDataAttrs"))){for(n=i.attributes;n.length>o;o++)r=n[o].name,0===r.indexOf("data-")&&(r=x.camelCase(r.slice(5)),P(i,r,s[r]));q.set(i,"hasDataAttrs",!0)}return s}return"object"==typeof e?this.each(function(){L.set(this,e)}):x.access(this,function(t){var n,r=x.camelCase(e);if(i&&t===undefined){if(n=L.get(i,e),n!==undefined)return n;if(n=L.get(i,r),n!==undefined)return n;if(n=P(i,r,undefined),n!==undefined)return n}else this.each(function(){var n=L.get(this,r);L.set(this,r,t),-1!==e.indexOf("-")&&n!==undefined&&L.set(this,e,t)})},null,t,arguments.length>1,null,!0)},removeData:function(e){return this.each(function(){L.remove(this,e)})}});function P(e,t,n){var r;if(n===undefined&&1===e.nodeType)if(r="data-"+t.replace(O,"-$1").toLowerCase(),n=e.getAttribute(r),"string"==typeof n){try{n="true"===n?!0:"false"===n?!1:"null"===n?null:+n+""===n?+n:H.test(n)?JSON.parse(n):n}catch(i){}L.set(e,t,n)}else n=undefined;return n}x.extend({queue:function(e,t,n){var r;return e?(t=(t||"fx")+"queue",r=q.get(e,t),n&&(!r||x.isArray(n)?r=q.access(e,t,x.makeArray(n)):r.push(n)),r||[]):undefined},dequeue:function(e,t){t=t||"fx";var n=x.queue(e,t),r=n.length,i=n.shift(),o=x._queueHooks(e,t),s=function(){x.dequeue(e,t) +};"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,s,o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return q.get(e,n)||q.access(e,n,{empty:x.Callbacks("once memory").add(function(){q.remove(e,[t+"queue",n])})})}}),x.fn.extend({queue:function(e,t){var n=2;return"string"!=typeof e&&(t=e,e="fx",n--),n>arguments.length?x.queue(this[0],e):t===undefined?this:this.each(function(){var n=x.queue(this,e,t);x._queueHooks(this,e),"fx"===e&&"inprogress"!==n[0]&&x.dequeue(this,e)})},dequeue:function(e){return this.each(function(){x.dequeue(this,e)})},delay:function(e,t){return e=x.fx?x.fx.speeds[e]||e:e,t=t||"fx",this.queue(t,function(t,n){var r=setTimeout(t,e);n.stop=function(){clearTimeout(r)}})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=x.Deferred(),o=this,s=this.length,a=function(){--r||i.resolveWith(o,[o])};"string"!=typeof e&&(t=e,e=undefined),e=e||"fx";while(s--)n=q.get(o[s],e+"queueHooks"),n&&n.empty&&(r++,n.empty.add(a));return a(),i.promise(t)}});var R,M,W=/[\t\r\n\f]/g,$=/\r/g,B=/^(?:input|select|textarea|button)$/i;x.fn.extend({attr:function(e,t){return x.access(this,x.attr,e,t,arguments.length>1)},removeAttr:function(e){return this.each(function(){x.removeAttr(this,e)})},prop:function(e,t){return x.access(this,x.prop,e,t,arguments.length>1)},removeProp:function(e){return this.each(function(){delete this[x.propFix[e]||e]})},addClass:function(e){var t,n,r,i,o,s=0,a=this.length,u="string"==typeof e&&e;if(x.isFunction(e))return this.each(function(t){x(this).addClass(e.call(this,t,this.className))});if(u)for(t=(e||"").match(w)||[];a>s;s++)if(n=this[s],r=1===n.nodeType&&(n.className?(" "+n.className+" ").replace(W," "):" ")){o=0;while(i=t[o++])0>r.indexOf(" "+i+" ")&&(r+=i+" ");n.className=x.trim(r)}return this},removeClass:function(e){var t,n,r,i,o,s=0,a=this.length,u=0===arguments.length||"string"==typeof e&&e;if(x.isFunction(e))return this.each(function(t){x(this).removeClass(e.call(this,t,this.className))});if(u)for(t=(e||"").match(w)||[];a>s;s++)if(n=this[s],r=1===n.nodeType&&(n.className?(" "+n.className+" ").replace(W," "):"")){o=0;while(i=t[o++])while(r.indexOf(" "+i+" ")>=0)r=r.replace(" "+i+" "," ");n.className=e?x.trim(r):""}return this},toggleClass:function(e,t){var n=typeof e;return"boolean"==typeof t&&"string"===n?t?this.addClass(e):this.removeClass(e):x.isFunction(e)?this.each(function(n){x(this).toggleClass(e.call(this,n,this.className,t),t)}):this.each(function(){if("string"===n){var t,i=0,o=x(this),s=e.match(w)||[];while(t=s[i++])o.hasClass(t)?o.removeClass(t):o.addClass(t)}else(n===r||"boolean"===n)&&(this.className&&q.set(this,"__className__",this.className),this.className=this.className||e===!1?"":q.get(this,"__className__")||"")})},hasClass:function(e){var t=" "+e+" ",n=0,r=this.length;for(;r>n;n++)if(1===this[n].nodeType&&(" "+this[n].className+" ").replace(W," ").indexOf(t)>=0)return!0;return!1},val:function(e){var t,n,r,i=this[0];{if(arguments.length)return r=x.isFunction(e),this.each(function(n){var i;1===this.nodeType&&(i=r?e.call(this,n,x(this).val()):e,null==i?i="":"number"==typeof i?i+="":x.isArray(i)&&(i=x.map(i,function(e){return null==e?"":e+""})),t=x.valHooks[this.type]||x.valHooks[this.nodeName.toLowerCase()],t&&"set"in t&&t.set(this,i,"value")!==undefined||(this.value=i))});if(i)return t=x.valHooks[i.type]||x.valHooks[i.nodeName.toLowerCase()],t&&"get"in t&&(n=t.get(i,"value"))!==undefined?n:(n=i.value,"string"==typeof n?n.replace($,""):null==n?"":n)}}}),x.extend({valHooks:{option:{get:function(e){var t=e.attributes.value;return!t||t.specified?e.value:e.text}},select:{get:function(e){var t,n,r=e.options,i=e.selectedIndex,o="select-one"===e.type||0>i,s=o?null:[],a=o?i+1:r.length,u=0>i?a:o?i:0;for(;a>u;u++)if(n=r[u],!(!n.selected&&u!==i||(x.support.optDisabled?n.disabled:null!==n.getAttribute("disabled"))||n.parentNode.disabled&&x.nodeName(n.parentNode,"optgroup"))){if(t=x(n).val(),o)return t;s.push(t)}return s},set:function(e,t){var n,r,i=e.options,o=x.makeArray(t),s=i.length;while(s--)r=i[s],(r.selected=x.inArray(x(r).val(),o)>=0)&&(n=!0);return n||(e.selectedIndex=-1),o}}},attr:function(e,t,n){var i,o,s=e.nodeType;if(e&&3!==s&&8!==s&&2!==s)return typeof e.getAttribute===r?x.prop(e,t,n):(1===s&&x.isXMLDoc(e)||(t=t.toLowerCase(),i=x.attrHooks[t]||(x.expr.match.bool.test(t)?M:R)),n===undefined?i&&"get"in i&&null!==(o=i.get(e,t))?o:(o=x.find.attr(e,t),null==o?undefined:o):null!==n?i&&"set"in i&&(o=i.set(e,n,t))!==undefined?o:(e.setAttribute(t,n+""),n):(x.removeAttr(e,t),undefined))},removeAttr:function(e,t){var n,r,i=0,o=t&&t.match(w);if(o&&1===e.nodeType)while(n=o[i++])r=x.propFix[n]||n,x.expr.match.bool.test(n)&&(e[r]=!1),e.removeAttribute(n)},attrHooks:{type:{set:function(e,t){if(!x.support.radioValue&&"radio"===t&&x.nodeName(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},propFix:{"for":"htmlFor","class":"className"},prop:function(e,t,n){var r,i,o,s=e.nodeType;if(e&&3!==s&&8!==s&&2!==s)return o=1!==s||!x.isXMLDoc(e),o&&(t=x.propFix[t]||t,i=x.propHooks[t]),n!==undefined?i&&"set"in i&&(r=i.set(e,n,t))!==undefined?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){return e.hasAttribute("tabindex")||B.test(e.nodeName)||e.href?e.tabIndex:-1}}}}),M={set:function(e,t,n){return t===!1?x.removeAttr(e,n):e.setAttribute(n,n),n}},x.each(x.expr.match.bool.source.match(/\w+/g),function(e,t){var n=x.expr.attrHandle[t]||x.find.attr;x.expr.attrHandle[t]=function(e,t,r){var i=x.expr.attrHandle[t],o=r?undefined:(x.expr.attrHandle[t]=undefined)!=n(e,t,r)?t.toLowerCase():null;return x.expr.attrHandle[t]=i,o}}),x.support.optSelected||(x.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null}}),x.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){x.propFix[this.toLowerCase()]=this}),x.each(["radio","checkbox"],function(){x.valHooks[this]={set:function(e,t){return x.isArray(t)?e.checked=x.inArray(x(e).val(),t)>=0:undefined}},x.support.checkOn||(x.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})});var I=/^key/,z=/^(?:mouse|contextmenu)|click/,_=/^(?:focusinfocus|focusoutblur)$/,X=/^([^.]*)(?:\.(.+)|)$/;function U(){return!0}function Y(){return!1}function V(){try{return o.activeElement}catch(e){}}x.event={global:{},add:function(e,t,n,i,o){var s,a,u,l,c,p,f,h,d,g,m,y=q.get(e);if(y){n.handler&&(s=n,n=s.handler,o=s.selector),n.guid||(n.guid=x.guid++),(l=y.events)||(l=y.events={}),(a=y.handle)||(a=y.handle=function(e){return typeof x===r||e&&x.event.triggered===e.type?undefined:x.event.dispatch.apply(a.elem,arguments)},a.elem=e),t=(t||"").match(w)||[""],c=t.length;while(c--)u=X.exec(t[c])||[],d=m=u[1],g=(u[2]||"").split(".").sort(),d&&(f=x.event.special[d]||{},d=(o?f.delegateType:f.bindType)||d,f=x.event.special[d]||{},p=x.extend({type:d,origType:m,data:i,handler:n,guid:n.guid,selector:o,needsContext:o&&x.expr.match.needsContext.test(o),namespace:g.join(".")},s),(h=l[d])||(h=l[d]=[],h.delegateCount=0,f.setup&&f.setup.call(e,i,g,a)!==!1||e.addEventListener&&e.addEventListener(d,a,!1)),f.add&&(f.add.call(e,p),p.handler.guid||(p.handler.guid=n.guid)),o?h.splice(h.delegateCount++,0,p):h.push(p),x.event.global[d]=!0);e=null}},remove:function(e,t,n,r,i){var o,s,a,u,l,c,p,f,h,d,g,m=q.hasData(e)&&q.get(e);if(m&&(u=m.events)){t=(t||"").match(w)||[""],l=t.length;while(l--)if(a=X.exec(t[l])||[],h=g=a[1],d=(a[2]||"").split(".").sort(),h){p=x.event.special[h]||{},h=(r?p.delegateType:p.bindType)||h,f=u[h]||[],a=a[2]&&RegExp("(^|\\.)"+d.join("\\.(?:.*\\.|)")+"(\\.|$)"),s=o=f.length;while(o--)c=f[o],!i&&g!==c.origType||n&&n.guid!==c.guid||a&&!a.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(f.splice(o,1),c.selector&&f.delegateCount--,p.remove&&p.remove.call(e,c));s&&!f.length&&(p.teardown&&p.teardown.call(e,d,m.handle)!==!1||x.removeEvent(e,h,m.handle),delete u[h])}else for(h in u)x.event.remove(e,h+t[l],n,r,!0);x.isEmptyObject(u)&&(delete m.handle,q.remove(e,"events"))}},trigger:function(t,n,r,i){var s,a,u,l,c,p,f,h=[r||o],d=y.call(t,"type")?t.type:t,g=y.call(t,"namespace")?t.namespace.split("."):[];if(a=u=r=r||o,3!==r.nodeType&&8!==r.nodeType&&!_.test(d+x.event.triggered)&&(d.indexOf(".")>=0&&(g=d.split("."),d=g.shift(),g.sort()),c=0>d.indexOf(":")&&"on"+d,t=t[x.expando]?t:new x.Event(d,"object"==typeof t&&t),t.isTrigger=i?2:3,t.namespace=g.join("."),t.namespace_re=t.namespace?RegExp("(^|\\.)"+g.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,t.result=undefined,t.target||(t.target=r),n=null==n?[t]:x.makeArray(n,[t]),f=x.event.special[d]||{},i||!f.trigger||f.trigger.apply(r,n)!==!1)){if(!i&&!f.noBubble&&!x.isWindow(r)){for(l=f.delegateType||d,_.test(l+d)||(a=a.parentNode);a;a=a.parentNode)h.push(a),u=a;u===(r.ownerDocument||o)&&h.push(u.defaultView||u.parentWindow||e)}s=0;while((a=h[s++])&&!t.isPropagationStopped())t.type=s>1?l:f.bindType||d,p=(q.get(a,"events")||{})[t.type]&&q.get(a,"handle"),p&&p.apply(a,n),p=c&&a[c],p&&x.acceptData(a)&&p.apply&&p.apply(a,n)===!1&&t.preventDefault();return t.type=d,i||t.isDefaultPrevented()||f._default&&f._default.apply(h.pop(),n)!==!1||!x.acceptData(r)||c&&x.isFunction(r[d])&&!x.isWindow(r)&&(u=r[c],u&&(r[c]=null),x.event.triggered=d,r[d](),x.event.triggered=undefined,u&&(r[c]=u)),t.result}},dispatch:function(e){e=x.event.fix(e);var t,n,r,i,o,s=[],a=d.call(arguments),u=(q.get(this,"events")||{})[e.type]||[],l=x.event.special[e.type]||{};if(a[0]=e,e.delegateTarget=this,!l.preDispatch||l.preDispatch.call(this,e)!==!1){s=x.event.handlers.call(this,e,u),t=0;while((i=s[t++])&&!e.isPropagationStopped()){e.currentTarget=i.elem,n=0;while((o=i.handlers[n++])&&!e.isImmediatePropagationStopped())(!e.namespace_re||e.namespace_re.test(o.namespace))&&(e.handleObj=o,e.data=o.data,r=((x.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,a),r!==undefined&&(e.result=r)===!1&&(e.preventDefault(),e.stopPropagation()))}return l.postDispatch&&l.postDispatch.call(this,e),e.result}},handlers:function(e,t){var n,r,i,o,s=[],a=t.delegateCount,u=e.target;if(a&&u.nodeType&&(!e.button||"click"!==e.type))for(;u!==this;u=u.parentNode||this)if(u.disabled!==!0||"click"!==e.type){for(r=[],n=0;a>n;n++)o=t[n],i=o.selector+" ",r[i]===undefined&&(r[i]=o.needsContext?x(i,this).index(u)>=0:x.find(i,this,null,[u]).length),r[i]&&r.push(o);r.length&&s.push({elem:u,handlers:r})}return t.length>a&&s.push({elem:this,handlers:t.slice(a)}),s},props:"altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "),fixHooks:{},keyHooks:{props:"char charCode key keyCode".split(" "),filter:function(e,t){return null==e.which&&(e.which=null!=t.charCode?t.charCode:t.keyCode),e}},mouseHooks:{props:"button buttons clientX clientY offsetX offsetY pageX pageY screenX screenY toElement".split(" "),filter:function(e,t){var n,r,i,s=t.button;return null==e.pageX&&null!=t.clientX&&(n=e.target.ownerDocument||o,r=n.documentElement,i=n.body,e.pageX=t.clientX+(r&&r.scrollLeft||i&&i.scrollLeft||0)-(r&&r.clientLeft||i&&i.clientLeft||0),e.pageY=t.clientY+(r&&r.scrollTop||i&&i.scrollTop||0)-(r&&r.clientTop||i&&i.clientTop||0)),e.which||s===undefined||(e.which=1&s?1:2&s?3:4&s?2:0),e}},fix:function(e){if(e[x.expando])return e;var t,n,r,i=e.type,s=e,a=this.fixHooks[i];a||(this.fixHooks[i]=a=z.test(i)?this.mouseHooks:I.test(i)?this.keyHooks:{}),r=a.props?this.props.concat(a.props):this.props,e=new x.Event(s),t=r.length;while(t--)n=r[t],e[n]=s[n];return e.target||(e.target=o),3===e.target.nodeType&&(e.target=e.target.parentNode),a.filter?a.filter(e,s):e},special:{load:{noBubble:!0},focus:{trigger:function(){return this!==V()&&this.focus?(this.focus(),!1):undefined},delegateType:"focusin"},blur:{trigger:function(){return this===V()&&this.blur?(this.blur(),!1):undefined},delegateType:"focusout"},click:{trigger:function(){return"checkbox"===this.type&&this.click&&x.nodeName(this,"input")?(this.click(),!1):undefined},_default:function(e){return x.nodeName(e.target,"a")}},beforeunload:{postDispatch:function(e){e.result!==undefined&&(e.originalEvent.returnValue=e.result)}}},simulate:function(e,t,n,r){var i=x.extend(new x.Event,n,{type:e,isSimulated:!0,originalEvent:{}});r?x.event.trigger(i,null,t):x.event.dispatch.call(t,i),i.isDefaultPrevented()&&n.preventDefault()}},x.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n,!1)},x.Event=function(e,t){return this instanceof x.Event?(e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||e.getPreventDefault&&e.getPreventDefault()?U:Y):this.type=e,t&&x.extend(this,t),this.timeStamp=e&&e.timeStamp||x.now(),this[x.expando]=!0,undefined):new x.Event(e,t)},x.Event.prototype={isDefaultPrevented:Y,isPropagationStopped:Y,isImmediatePropagationStopped:Y,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=U,e&&e.preventDefault&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=U,e&&e.stopPropagation&&e.stopPropagation()},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=U,this.stopPropagation()}},x.each({mouseenter:"mouseover",mouseleave:"mouseout"},function(e,t){x.event.special[e]={delegateType:t,bindType:t,handle:function(e){var n,r=this,i=e.relatedTarget,o=e.handleObj;return(!i||i!==r&&!x.contains(r,i))&&(e.type=o.origType,n=o.handler.apply(this,arguments),e.type=t),n}}}),x.support.focusinBubbles||x.each({focus:"focusin",blur:"focusout"},function(e,t){var n=0,r=function(e){x.event.simulate(t,e.target,x.event.fix(e),!0)};x.event.special[t]={setup:function(){0===n++&&o.addEventListener(e,r,!0)},teardown:function(){0===--n&&o.removeEventListener(e,r,!0)}}}),x.fn.extend({on:function(e,t,n,r,i){var o,s;if("object"==typeof e){"string"!=typeof t&&(n=n||t,t=undefined);for(s in e)this.on(s,t,n,e[s],i);return this}if(null==n&&null==r?(r=t,n=t=undefined):null==r&&("string"==typeof t?(r=n,n=undefined):(r=n,n=t,t=undefined)),r===!1)r=Y;else if(!r)return this;return 1===i&&(o=r,r=function(e){return x().off(e),o.apply(this,arguments)},r.guid=o.guid||(o.guid=x.guid++)),this.each(function(){x.event.add(this,e,r,n,t)})},one:function(e,t,n,r){return this.on(e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,x(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return(t===!1||"function"==typeof t)&&(n=t,t=undefined),n===!1&&(n=Y),this.each(function(){x.event.remove(this,e,n,t)})},trigger:function(e,t){return this.each(function(){x.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];return n?x.event.trigger(e,t,n,!0):undefined}});var G=/^.[^:#\[\.,]*$/,J=/^(?:parents|prev(?:Until|All))/,Q=x.expr.match.needsContext,K={children:!0,contents:!0,next:!0,prev:!0};x.fn.extend({find:function(e){var t,n=[],r=this,i=r.length;if("string"!=typeof e)return this.pushStack(x(e).filter(function(){for(t=0;i>t;t++)if(x.contains(r[t],this))return!0}));for(t=0;i>t;t++)x.find(e,r[t],n);return n=this.pushStack(i>1?x.unique(n):n),n.selector=this.selector?this.selector+" "+e:e,n},has:function(e){var t=x(e,this),n=t.length;return this.filter(function(){var e=0;for(;n>e;e++)if(x.contains(this,t[e]))return!0})},not:function(e){return this.pushStack(et(this,e||[],!0))},filter:function(e){return this.pushStack(et(this,e||[],!1))},is:function(e){return!!et(this,"string"==typeof e&&Q.test(e)?x(e):e||[],!1).length},closest:function(e,t){var n,r=0,i=this.length,o=[],s=Q.test(e)||"string"!=typeof e?x(e,t||this.context):0;for(;i>r;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(11>n.nodeType&&(s?s.index(n)>-1:1===n.nodeType&&x.find.matchesSelector(n,e))){n=o.push(n);break}return this.pushStack(o.length>1?x.unique(o):o)},index:function(e){return e?"string"==typeof e?g.call(x(e),this[0]):g.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){var n="string"==typeof e?x(e,t):x.makeArray(e&&e.nodeType?[e]:e),r=x.merge(this.get(),n);return this.pushStack(x.unique(r))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}});function Z(e,t){while((e=e[t])&&1!==e.nodeType);return e}x.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return x.dir(e,"parentNode")},parentsUntil:function(e,t,n){return x.dir(e,"parentNode",n)},next:function(e){return Z(e,"nextSibling")},prev:function(e){return Z(e,"previousSibling")},nextAll:function(e){return x.dir(e,"nextSibling")},prevAll:function(e){return x.dir(e,"previousSibling")},nextUntil:function(e,t,n){return x.dir(e,"nextSibling",n)},prevUntil:function(e,t,n){return x.dir(e,"previousSibling",n)},siblings:function(e){return x.sibling((e.parentNode||{}).firstChild,e)},children:function(e){return x.sibling(e.firstChild)},contents:function(e){return e.contentDocument||x.merge([],e.childNodes)}},function(e,t){x.fn[e]=function(n,r){var i=x.map(this,t,n);return"Until"!==e.slice(-5)&&(r=n),r&&"string"==typeof r&&(i=x.filter(r,i)),this.length>1&&(K[e]||x.unique(i),J.test(e)&&i.reverse()),this.pushStack(i)}}),x.extend({filter:function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?x.find.matchesSelector(r,e)?[r]:[]:x.find.matches(e,x.grep(t,function(e){return 1===e.nodeType}))},dir:function(e,t,n){var r=[],i=n!==undefined;while((e=e[t])&&9!==e.nodeType)if(1===e.nodeType){if(i&&x(e).is(n))break;r.push(e)}return r},sibling:function(e,t){var n=[];for(;e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n}});function et(e,t,n){if(x.isFunction(t))return x.grep(e,function(e,r){return!!t.call(e,r,e)!==n});if(t.nodeType)return x.grep(e,function(e){return e===t!==n});if("string"==typeof t){if(G.test(t))return x.filter(t,e,n);t=x.filter(t,e)}return x.grep(e,function(e){return g.call(t,e)>=0!==n})}var tt=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,nt=/<([\w:]+)/,rt=/<|&#?\w+;/,it=/<(?:script|style|link)/i,ot=/^(?:checkbox|radio)$/i,st=/checked\s*(?:[^=]|=\s*.checked.)/i,at=/^$|\/(?:java|ecma)script/i,ut=/^true\/(.*)/,lt=/^\s*\s*$/g,ct={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};ct.optgroup=ct.option,ct.tbody=ct.tfoot=ct.colgroup=ct.caption=ct.thead,ct.th=ct.td,x.fn.extend({text:function(e){return x.access(this,function(e){return e===undefined?x.text(this):this.empty().append((this[0]&&this[0].ownerDocument||o).createTextNode(e))},null,e,arguments.length)},append:function(){return this.domManip(arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=pt(this,e);t.appendChild(e)}})},prepend:function(){return this.domManip(arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=pt(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return this.domManip(arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return this.domManip(arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},remove:function(e,t){var n,r=e?x.filter(e,this):this,i=0;for(;null!=(n=r[i]);i++)t||1!==n.nodeType||x.cleanData(mt(n)),n.parentNode&&(t&&x.contains(n.ownerDocument,n)&&dt(mt(n,"script")),n.parentNode.removeChild(n));return this},empty:function(){var e,t=0;for(;null!=(e=this[t]);t++)1===e.nodeType&&(x.cleanData(mt(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null==e?!1:e,t=null==t?e:t,this.map(function(){return x.clone(this,e,t)})},html:function(e){return x.access(this,function(e){var t=this[0]||{},n=0,r=this.length;if(e===undefined&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!it.test(e)&&!ct[(nt.exec(e)||["",""])[1].toLowerCase()]){e=e.replace(tt,"<$1>");try{for(;r>n;n++)t=this[n]||{},1===t.nodeType&&(x.cleanData(mt(t,!1)),t.innerHTML=e);t=0}catch(i){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var e=x.map(this,function(e){return[e.nextSibling,e.parentNode]}),t=0;return this.domManip(arguments,function(n){var r=e[t++],i=e[t++];i&&(r&&r.parentNode!==i&&(r=this.nextSibling),x(this).remove(),i.insertBefore(n,r))},!0),t?this:this.remove()},detach:function(e){return this.remove(e,!0)},domManip:function(e,t,n){e=f.apply([],e);var r,i,o,s,a,u,l=0,c=this.length,p=this,h=c-1,d=e[0],g=x.isFunction(d);if(g||!(1>=c||"string"!=typeof d||x.support.checkClone)&&st.test(d))return this.each(function(r){var i=p.eq(r);g&&(e[0]=d.call(this,r,i.html())),i.domManip(e,t,n)});if(c&&(r=x.buildFragment(e,this[0].ownerDocument,!1,!n&&this),i=r.firstChild,1===r.childNodes.length&&(r=i),i)){for(o=x.map(mt(r,"script"),ft),s=o.length;c>l;l++)a=r,l!==h&&(a=x.clone(a,!0,!0),s&&x.merge(o,mt(a,"script"))),t.call(this[l],a,l);if(s)for(u=o[o.length-1].ownerDocument,x.map(o,ht),l=0;s>l;l++)a=o[l],at.test(a.type||"")&&!q.access(a,"globalEval")&&x.contains(u,a)&&(a.src?x._evalUrl(a.src):x.globalEval(a.textContent.replace(lt,"")))}return this}}),x.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,t){x.fn[e]=function(e){var n,r=[],i=x(e),o=i.length-1,s=0;for(;o>=s;s++)n=s===o?this:this.clone(!0),x(i[s])[t](n),h.apply(r,n.get());return this.pushStack(r)}}),x.extend({clone:function(e,t,n){var r,i,o,s,a=e.cloneNode(!0),u=x.contains(e.ownerDocument,e);if(!(x.support.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||x.isXMLDoc(e)))for(s=mt(a),o=mt(e),r=0,i=o.length;i>r;r++)yt(o[r],s[r]);if(t)if(n)for(o=o||mt(e),s=s||mt(a),r=0,i=o.length;i>r;r++)gt(o[r],s[r]);else gt(e,a);return s=mt(a,"script"),s.length>0&&dt(s,!u&&mt(e,"script")),a},buildFragment:function(e,t,n,r){var i,o,s,a,u,l,c=0,p=e.length,f=t.createDocumentFragment(),h=[];for(;p>c;c++)if(i=e[c],i||0===i)if("object"===x.type(i))x.merge(h,i.nodeType?[i]:i);else if(rt.test(i)){o=o||f.appendChild(t.createElement("div")),s=(nt.exec(i)||["",""])[1].toLowerCase(),a=ct[s]||ct._default,o.innerHTML=a[1]+i.replace(tt,"<$1>")+a[2],l=a[0];while(l--)o=o.lastChild;x.merge(h,o.childNodes),o=f.firstChild,o.textContent=""}else h.push(t.createTextNode(i));f.textContent="",c=0;while(i=h[c++])if((!r||-1===x.inArray(i,r))&&(u=x.contains(i.ownerDocument,i),o=mt(f.appendChild(i),"script"),u&&dt(o),n)){l=0;while(i=o[l++])at.test(i.type||"")&&n.push(i)}return f},cleanData:function(e){var t,n,r,i,o,s,a=x.event.special,u=0;for(;(n=e[u])!==undefined;u++){if(F.accepts(n)&&(o=n[q.expando],o&&(t=q.cache[o]))){if(r=Object.keys(t.events||{}),r.length)for(s=0;(i=r[s])!==undefined;s++)a[i]?x.event.remove(n,i):x.removeEvent(n,i,t.handle);q.cache[o]&&delete q.cache[o]}delete L.cache[n[L.expando]]}},_evalUrl:function(e){return x.ajax({url:e,type:"GET",dataType:"script",async:!1,global:!1,"throws":!0})}});function pt(e,t){return x.nodeName(e,"table")&&x.nodeName(1===t.nodeType?t:t.firstChild,"tr")?e.getElementsByTagName("tbody")[0]||e.appendChild(e.ownerDocument.createElement("tbody")):e}function ft(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function ht(e){var t=ut.exec(e.type);return t?e.type=t[1]:e.removeAttribute("type"),e}function dt(e,t){var n=e.length,r=0;for(;n>r;r++)q.set(e[r],"globalEval",!t||q.get(t[r],"globalEval"))}function gt(e,t){var n,r,i,o,s,a,u,l;if(1===t.nodeType){if(q.hasData(e)&&(o=q.access(e),s=q.set(t,o),l=o.events)){delete s.handle,s.events={};for(i in l)for(n=0,r=l[i].length;r>n;n++)x.event.add(t,i,l[i][n])}L.hasData(e)&&(a=L.access(e),u=x.extend({},a),L.set(t,u))}}function mt(e,t){var n=e.getElementsByTagName?e.getElementsByTagName(t||"*"):e.querySelectorAll?e.querySelectorAll(t||"*"):[];return t===undefined||t&&x.nodeName(e,t)?x.merge([e],n):n}function yt(e,t){var n=t.nodeName.toLowerCase();"input"===n&&ot.test(e.type)?t.checked=e.checked:("input"===n||"textarea"===n)&&(t.defaultValue=e.defaultValue)}x.fn.extend({wrapAll:function(e){var t;return x.isFunction(e)?this.each(function(t){x(this).wrapAll(e.call(this,t))}):(this[0]&&(t=x(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstElementChild)e=e.firstElementChild;return e}).append(this)),this)},wrapInner:function(e){return x.isFunction(e)?this.each(function(t){x(this).wrapInner(e.call(this,t))}):this.each(function(){var t=x(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=x.isFunction(e);return this.each(function(n){x(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(){return this.parent().each(function(){x.nodeName(this,"body")||x(this).replaceWith(this.childNodes)}).end()}});var vt,xt,bt=/^(none|table(?!-c[ea]).+)/,wt=/^margin/,Tt=RegExp("^("+b+")(.*)$","i"),Ct=RegExp("^("+b+")(?!px)[a-z%]+$","i"),kt=RegExp("^([+-])=("+b+")","i"),Nt={BODY:"block"},Et={position:"absolute",visibility:"hidden",display:"block"},St={letterSpacing:0,fontWeight:400},jt=["Top","Right","Bottom","Left"],Dt=["Webkit","O","Moz","ms"];function At(e,t){if(t in e)return t;var n=t.charAt(0).toUpperCase()+t.slice(1),r=t,i=Dt.length;while(i--)if(t=Dt[i]+n,t in e)return t;return r}function Lt(e,t){return e=t||e,"none"===x.css(e,"display")||!x.contains(e.ownerDocument,e)}function qt(t){return e.getComputedStyle(t,null)}function Ht(e,t){var n,r,i,o=[],s=0,a=e.length;for(;a>s;s++)r=e[s],r.style&&(o[s]=q.get(r,"olddisplay"),n=r.style.display,t?(o[s]||"none"!==n||(r.style.display=""),""===r.style.display&&Lt(r)&&(o[s]=q.access(r,"olddisplay",Rt(r.nodeName)))):o[s]||(i=Lt(r),(n&&"none"!==n||!i)&&q.set(r,"olddisplay",i?n:x.css(r,"display"))));for(s=0;a>s;s++)r=e[s],r.style&&(t&&"none"!==r.style.display&&""!==r.style.display||(r.style.display=t?o[s]||"":"none"));return e}x.fn.extend({css:function(e,t){return x.access(this,function(e,t,n){var r,i,o={},s=0;if(x.isArray(t)){for(r=qt(e),i=t.length;i>s;s++)o[t[s]]=x.css(e,t[s],!1,r);return o}return n!==undefined?x.style(e,t,n):x.css(e,t)},e,t,arguments.length>1)},show:function(){return Ht(this,!0)},hide:function(){return Ht(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){Lt(this)?x(this).show():x(this).hide()})}}),x.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=vt(e,"opacity");return""===n?"1":n}}}},cssNumber:{columnCount:!0,fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":"cssFloat"},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,s,a=x.camelCase(t),u=e.style;return t=x.cssProps[a]||(x.cssProps[a]=At(u,a)),s=x.cssHooks[t]||x.cssHooks[a],n===undefined?s&&"get"in s&&(i=s.get(e,!1,r))!==undefined?i:u[t]:(o=typeof n,"string"===o&&(i=kt.exec(n))&&(n=(i[1]+1)*i[2]+parseFloat(x.css(e,t)),o="number"),null==n||"number"===o&&isNaN(n)||("number"!==o||x.cssNumber[a]||(n+="px"),x.support.clearCloneStyle||""!==n||0!==t.indexOf("background")||(u[t]="inherit"),s&&"set"in s&&(n=s.set(e,n,r))===undefined||(u[t]=n)),undefined)}},css:function(e,t,n,r){var i,o,s,a=x.camelCase(t);return t=x.cssProps[a]||(x.cssProps[a]=At(e.style,a)),s=x.cssHooks[t]||x.cssHooks[a],s&&"get"in s&&(i=s.get(e,!0,n)),i===undefined&&(i=vt(e,t,r)),"normal"===i&&t in St&&(i=St[t]),""===n||n?(o=parseFloat(i),n===!0||x.isNumeric(o)?o||0:i):i}}),vt=function(e,t,n){var r,i,o,s=n||qt(e),a=s?s.getPropertyValue(t)||s[t]:undefined,u=e.style;return s&&(""!==a||x.contains(e.ownerDocument,e)||(a=x.style(e,t)),Ct.test(a)&&wt.test(t)&&(r=u.width,i=u.minWidth,o=u.maxWidth,u.minWidth=u.maxWidth=u.width=a,a=s.width,u.width=r,u.minWidth=i,u.maxWidth=o)),a};function Ot(e,t,n){var r=Tt.exec(t);return r?Math.max(0,r[1]-(n||0))+(r[2]||"px"):t}function Ft(e,t,n,r,i){var o=n===(r?"border":"content")?4:"width"===t?1:0,s=0;for(;4>o;o+=2)"margin"===n&&(s+=x.css(e,n+jt[o],!0,i)),r?("content"===n&&(s-=x.css(e,"padding"+jt[o],!0,i)),"margin"!==n&&(s-=x.css(e,"border"+jt[o]+"Width",!0,i))):(s+=x.css(e,"padding"+jt[o],!0,i),"padding"!==n&&(s+=x.css(e,"border"+jt[o]+"Width",!0,i)));return s}function Pt(e,t,n){var r=!0,i="width"===t?e.offsetWidth:e.offsetHeight,o=qt(e),s=x.support.boxSizing&&"border-box"===x.css(e,"boxSizing",!1,o);if(0>=i||null==i){if(i=vt(e,t,o),(0>i||null==i)&&(i=e.style[t]),Ct.test(i))return i;r=s&&(x.support.boxSizingReliable||i===e.style[t]),i=parseFloat(i)||0}return i+Ft(e,t,n||(s?"border":"content"),r,o)+"px"}function Rt(e){var t=o,n=Nt[e];return n||(n=Mt(e,t),"none"!==n&&n||(xt=(xt||x("