diff --git a/utils/rockbox_api/gen_html.php b/utils/rockbox_api/gen_html.php index 34e124f411..b3cec02036 100755 --- a/utils/rockbox_api/gen_html.php +++ b/utils/rockbox_api/gen_html.php @@ -9,102 +9,157 @@ function get_group($text) $input = file_get_contents($argv[1]); +$mypath = $_SERVER['SCRIPT_FILENAME']; +$mypath = substr($mypath, 0, strrpos($mypath, "/"))."/"; + $inh = parse_documentation($input); @mkdir("output"); -$h = fopen("output/index.html", "w"); +$index_tpl = file_get_contents($mypath."index.tpl"); -fwrite($h, 'Plugin API - INDEX'); +$group_data = array(); +$group_tpl = array(); +ereg("%GROUP_START%.*%GROUP_END%", $index_tpl, $group_tpl); +$group_tpl = str_replace(array("%GROUP_START%", "%GROUP_END%"), "", $group_tpl[0]); -fwrite($h, "

Plugin API reference

"); -fwrite($h, ""); -fclose($h); +$index_tpl = ereg_replace("%GROUP_START%.*%GROUP_END%", implode("", $group_data), $index_tpl); +file_put_contents("output/index.html", $index_tpl); -$menu = '"; +$menu = ereg_replace("%GROUP_START%.*%GROUP_END%", implode("", $menu), $menu_tpl); + +$section_tpl = file_get_contents($mypath."section.tpl"); + +$func_tpl = array(); +ereg("%FUNCTION_START%.*%FUNCTION_END%", $section_tpl, $func_tpl); +$func_tpl = str_replace(array("%FUNCTION_START%", "%FUNCTION_END%"), "", $func_tpl[0]); + +$description_tpl = array(); +ereg("%DESCRIPTION_START%.*%DESCRIPTION_END%", $func_tpl, $description_tpl); +$description_tpl = str_replace(array("%DESCRIPTION_START%", "%DESCRIPTION_END%"), "", $description_tpl[0]); + +$parameter_tpl = array(); +ereg("%PARAMETER_START%.*%PARAMETER_END%", $func_tpl, $parameter_tpl); +$parameter_tpl = str_replace(array("%PARAMETER_START%", "%PARAMETER_END%"), "", $parameter_tpl[0]); + +$parameters_tpl = array(); +ereg("%PARAMETERS_START%.*%PARAMETERS_END%", $parameter_tpl, $parameters_tpl); +$parameters_tpl = str_replace(array("%PARAMETERS_START%", "%PARAMETERS_END%"), "", $parameters_tpl[0]); + +$return_tpl = array(); +ereg("%RETURN_START%.*%RETURN_END%", $func_tpl, $return_tpl); +$return_tpl = str_replace(array("%RETURN_START%", "%RETURN_END%"), "", $return_tpl[0]); + +$conditions_tpl = array(); +ereg("%CONDITIONS_START%.*%CONDITIONS_END%", $func_tpl, $conditions_tpl); +$conditions_tpl = str_replace(array("%CONDITIONS_START%", "%CONDITIONS_END%"), "", $conditions_tpl[0]); + +$see_tpl = array(); +ereg("%SEE_START%.*%SEE_END%", $func_tpl, $see_tpl); +$see_tpl = str_replace(array("%SEE_START%", "%SEE_END%"), "", $see_tpl[0]); foreach($inh as $group_name => $group) { - $h = fopen("output/".get_group($group_name).".html", "w"); - - fwrite($h, 'Plugin API - '.ucwords($group_name).''); - fwrite($h, ''); - fwrite($h, '
'); - fwrite($h, ''); - - fwrite($h, "

".ucwords($group_name)."

"); - fwrite($h, ''); + $section_data = str_replace(array("%MENU%", "%GROUP_NAME%"), array($menu, ucwords($group_name)), $section_tpl); + + $funcs_data = array(); foreach($group as $func_name => $func) { - fwrite($h, ''); - - fwrite($h, "

$func_name

"); + $func_data = str_replace(array("%FUNCTION_NAME%", "%FUNCTION%"), array(get_func($func_name), $func_name), $func_tpl); if(strlen($func["description"][0]) > 0) - fwrite($h, do_markup($func["description"][0])."

"); - + $func_data = ereg_replace("%DESCRIPTION_START%.*%DESCRIPTION_END%", + str_replace("%FUNCTION_DESCRIPTION%", do_markup($func["description"][0]), $description_tpl), + $func_data); + else + $func_data = ereg_replace("%DESCRIPTION_START%.*%DESCRIPTION_END%", "", $func_data); + if(isset($func["param"])) { - $params = ""; + $params_data = array(); foreach($func["param"] as $param) { $param = trim($param); $p1 = substr($param, 0, strpos($param, " ")); - $p2 = substr($param, strpos($param, " ")); + $p2 = do_markup(substr($param, strpos($param, " "))); + if(strlen($p1) > 0 && strlen($p2) > 0) - $params .= '
'.$p1.'
'.do_markup($p2).'
'; + $params_data[] = str_replace(array("%PARAM1%", "%PARAM2%"), array($p1, $p2), $parameters_tpl); } - if(strlen($params) > 0) - { - fwrite($h, 'Parameters:
'); - fwrite($h, $params); - fwrite($h, "
"); - } + + if(count($params_data) > 0) + $func_data = ereg_replace("%PARAMETER_START%.*%PARAMETER_END%", + ereg_replace("%PARAMETERS_START%.*%PARAMETERS_END%", implode("\n", $params_data), $parameter_tpl), + $func_data); + else + $func_data = ereg_replace("%PARAMETER_START%.*%PARAMETER_END%", "", $func_data); } + else + $func_data = ereg_replace("%PARAMETER_START%.*%PARAMETER_END%", "", $func_data); if(isset($func["return"]) && strlen($func["return"][0]) > 0) - fwrite($h, 'Returns: '.do_markup($func["return"][0]).'

'); + $func_data = ereg_replace("%RETURN_START%.*%RETURN_END%", + str_replace("%RETURN%", do_markup($func["return"][0]), $return_tpl), + $func_data); + else + $func_data = ereg_replace("%RETURN_START%.*%RETURN_END%", "", $func_data); if(isset($func["conditions"])) - fwrite($h, 'Conditions: '.$func["conditions"][0].'

'); + $func_data = ereg_replace("%CONDITIONS_START%.*%CONDITIONS_END%", + str_replace("%CONDITIONS%", $func["conditions"][0], $conditions_tpl), + $func_data); + else + $func_data = ereg_replace("%CONDITIONS_START%.*%CONDITIONS_END%", "", $func_data); if(isset($func["see"])) - fwrite($h, 'Also see '.do_see_markup(explode(" ", trim($func["see"][0]))).'

'); - - fwrite($h, 'To top
'); + $func_data = ereg_replace("%SEE_START%.*%SEE_END%", + str_replace("%SEE%", do_see_markup(explode(" ", trim($func["see"][0]))), $see_tpl), + $func_data); + else + $func_data = ereg_replace("%SEE_START%.*%SEE_END%", "", $func_data); + + $funcs_data[] = $func_data; } - fwrite($h, ""); + $section_data = ereg_replace("%FUNCTION_START%.*%FUNCTION_END%", implode("", $funcs_data), $section_data); - fwrite($h, "
"); - - fclose($h); + file_put_contents("output/".get_group($group_name).".html", $section_data); } -copy("layout.css", "output/layout.css"); +copy($mypath."layout.css", "output/layout.css"); ?> \ No newline at end of file diff --git a/utils/rockbox_api/index.tpl b/utils/rockbox_api/index.tpl new file mode 100644 index 0000000000..ccbd5965ad --- /dev/null +++ b/utils/rockbox_api/index.tpl @@ -0,0 +1,23 @@ + + + + + Plugin API - INDEX + + + +

Plugin API reference

+ + + + \ No newline at end of file diff --git a/utils/rockbox_api/menu.tpl b/utils/rockbox_api/menu.tpl new file mode 100644 index 0000000000..4eae437f5c --- /dev/null +++ b/utils/rockbox_api/menu.tpl @@ -0,0 +1,8 @@ + \ No newline at end of file diff --git a/utils/rockbox_api/section.tpl b/utils/rockbox_api/section.tpl new file mode 100644 index 0000000000..874703cb9c --- /dev/null +++ b/utils/rockbox_api/section.tpl @@ -0,0 +1,50 @@ + + + + +Plugin API - %GROUP_NAME% + + + + +
+ +

%GROUP_NAME%

+ + %FUNCTION_START% + +

%FUNCTION%

+ + %DESCRIPTION_START% + %FUNCTION_DESCRIPTION% +

+ %DESCRIPTION_END% + + %PARAMETER_START% + Parameters: +
+ %PARAMETERS_START% +
%PARAM1%
%PARAM2%
+ %PARAMETERS_END% +
+ %PARAMETER_END% + + %RETURN_START% + Returns: %RETURN%

+ %RETURN_END% + + %CONDITIONS_START% + Conditions: %CONDITIONS%

+ %CONDITIONS_END% + + %SEE_START% + Also see %SEE%

+ %SEE_END% + + To top
+ + %FUNCTION_END% + +
+ + \ No newline at end of file