#   Copyright (c) 2007 Axel Wachtler
#   All rights reserved.
#
#   Redistribution and use in source and binary forms, with or without
#   modification, are permitted provided that the following conditions
#   are met:
#
#   * Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#   * Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#   * Neither the name of the authors nor the names of its contributors
#     may be used to endorse or promote products derived from this software
#     without specific prior written permission.
#
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
#   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
#   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
#   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
#   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
#   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
#   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
#   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
#   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
#   POSSIBILITY OF SUCH DAMAGE.

# $Id$

#=== modules ==================================================================
import os
from pprint import pprint as pp
import boardcfg
Import("doc")

#=== setup build environment ==================================================
udoc = doc.Clone()

def create_board_dox(target, source, env):
    target = str(target[0])
    sources = map(str,source)
    f = open(target,"w")
    f.write(boardcfg.boards_to_dox())
    f.close()

udoc['BUILDERS']['BoardDoxWriter'] = Builder(action = create_board_dox)


udoc['dir_build'] = udoc.Dir(".")
udoc['dox_install_dir'] = udoc.Dir("$dox_install_dir/usr")
udoc['dox_title'] = "User Guide"
udoc['dox_source_browser'] = "YES"
udoc['dox_generate_tagfile'] = "usr.tag"
udoc['dox_tagfiles'] = ""
udoc['dox_example_path'] = "./Src/Xmpl"
#=== targets ==========================================================

udoc["dox_input_files"] = "\
    ${dir_top}/Doc/Usr/main.dox\
    ${dir_top}/Doc/Usr/usr.dox\
    ${dir_top}/Doc/Usr/libradio.dox\
    ${dir_top}/Doc/Usr/libioutil.dox\
    ${dir_top}/Doc/Usr/definitions.dox\
    ${dir_top}/Src/Lib/Inc/const.h\
    ${dir_top}/Src/Lib/Inc/board.h\
    ${dir_top}/Src/Lib/Inc/transceiver.h\
    ${dir_top}/Src/Lib/Inc/radio.h\
    ${dir_top}/Src/Lib/Inc/timer.h\
    ${dir_top}/Src/Lib/Inc/hif.h\
    ${dir_top}/Src/Lib/Inc/ioutil.h\
    ${dir_top}/install/inc/at86rf230a.h\
    ${dir_top}/install/inc/at86rf230b.h\
    ${dir_top}/install/inc/at86rf231.h\
    ${dir_top}/install/inc/at86rf212.h\
    ${dir_top}/Src/Xmpl/xmpl.h\
    ${dir_build}/boards.dox\
    "

udoc["dox_input_files"] += " ".join(["${dir_top}/Src/Lib/Inc/%s" % \
								i.include for i in udoc["boards"].values()])

#=== targets ==========================================================


boardfile = udoc.BoardDoxWriter("boards.dox", "#$BOARD_CFG_FILE")

doxyfile = udoc.DoxyfileTransformer("Doxyfile",
		["${dir_src_doc}/Doxyfile.in", boardfile])

htmlfile = udoc.Command("${dox_install_dir}/index.html",
                         [doxyfile, "${dir_src_doc}/uracoli.css",
                          "${dir_install_doc}/xmpl",
                         "${dir_src_doc}/header.html", "${dir_src_doc}/footer.html"],
                         ["doxygen $SOURCE"])

udoc.Depends(htmlfile, udoc.Split("${dox_input_files} ${dir_top}/LICENSE"))
xmplsrc = udoc.Glob("${dir_top}/Src/Xmpl/xmpl*.[hc]")
udoc.Depends(htmlfile, xmplsrc)
