Changeset 12601

Timestamp:

02/21/08 18:01:30 (11 months ago)

Author:

pottedmeat

Message:

Refs #5602.

• Fix some dojo.declare example issues
  
• Add example theming
  
• Update GeSHi CSS
  
• Add a quick namespace calculation thinger
  

Location:

util

Files:

• branches/dev/jsdoc/INSTALL (modified) (1 diff)
• branches/dev/jsdoc/jsdoc.css (modified) (1 diff)
• branches/dev/jsdoc/jsdoc.install (modified) (2 diffs)
• branches/dev/jsdoc/jsdoc.module (modified) (12 diffs)
• trunk/docscripts/includes/dojo.inc (modified) (2 diffs)
• trunk/docscripts/lib/parser/DojoObject.php (modified) (1 diff)

util/branches/dev/jsdoc/INSTALL

@@ -16 +16 @@
 =====================
 
+http://drupal.org/node/70151
 Drop the jsdoc folder into sites/all/modules
 

util/branches/dev/jsdoc/jsdoc.css

@@ -1 @@
-/**
- * GeSHi Dynamically Generated Stylesheet
- * --------------------------------------
- * Dynamically generated stylesheet for javascript
- * CSS class: javascript, CSS id: 
- * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
- */
-.javascript .de1, .javascript .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
-.javascript  {}
-.javascript .head {}
-.javascript .foot {}
-.javascript .imp {font-weight: bold; color: red;}
-.javascript .ln-xtra {color: #cc0; background-color: #ffc;}
-.javascript li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
-.javascript li.li2 {font-weight: bold;}
-.javascript .kw1 {color: #000066; font-weight: bold;}
-.javascript .kw2 {color: #003366; font-weight: bold;}
+/* GeSHi (c) Nigel McNie 2004 (http://qbnz.com/highlighter) */
+.javascript .de1, .javascript .de2 {font-weight:normal;background:transparent;color:#000; padding-left: 5px;}
+.javascript .kw1 {color: #a1a100;}
+.javascript .kw2 {color: #000; font-weight: bold;}
 .javascript .kw3 {color: #000066;}
-.javascript .co1 {color: #009900; font-style: italic;}
-.javascript .coMULTI {color: #009900; font-style: italic;}
-.javascript .es0 {color: #000099; font-weight: bold;}
+.javascript .kw4 {color: #f63333;}
+.javascript .co1, .javascript .co2, .javascript .coMULTI {color: #808080;}
+.javascript .es0 {color: #000033; font-weight: bold;}
 .javascript .br0 {color: #66cc66;}
-.javascript .st0 {color: #3366CC;}
-.javascript .nu0 {color: #CC0000;}
-.javascript .me1 {color: #006600;}
-.javascript .sc0 {}
-.javascript .sc1 {}
-.javascript .sc2 {}
-.javascript .sc3 {}
-.javascript .re0 {color: #0066FF;}
-/**
- * GeSHi Dynamically Generated Stylesheet
- * --------------------------------------
- * Dynamically generated stylesheet for javascript
- * CSS class: javascript, CSS id: 
- * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
- */
-.javascript .de1, .javascript .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
-.javascript  {}
-.javascript .head {}
-.javascript .foot {}
-.javascript .imp {font-weight: bold; color: red;}
-.javascript .ln-xtra {color: #cc0; background-color: #ffc;}
-.javascript li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
-.javascript li.li2 {font-weight: bold;}
-.javascript .kw1 {color: #000066; font-weight: bold;}
-.javascript .kw2 {color: #003366; font-weight: bold;}
-.javascript .kw3 {color: #000066;}
-.javascript .kw4 {color: #600000;}
-.javascript .co1 {color: #009900; font-style: italic;}
-.javascript .coMULTI {color: #009900; font-style: italic;}
-.javascript .es0 {color: #000099; font-weight: bold;}
-.javascript .br0 {color: #66cc66;}
-.javascript .st0 {color: #3366CC;}
-.javascript .nu0 {color: #CC0000;}
-.javascript .me1 {color: #006600;}
-.javascript .sc0 {}
-.javascript .sc1 {}
-.javascript .sc2 {}
-.javascript .sc3 {}
-.javascript .re0 {color: #0066FF;}
-/**
- * GeSHi Dynamically Generated Stylesheet
- * --------------------------------------
- * Dynamically generated stylesheet for javascript
- * CSS class: javascript, CSS id: 
- * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
- */
-.javascript .de1, .javascript .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
-.javascript  {}
-.javascript .head {}
-.javascript .foot {}
-.javascript .imp {font-weight: bold; color: red;}
-.javascript .ln-xtra {color: #cc0; background-color: #ffc;}
-.javascript li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
-.javascript li.li2 {font-weight: bold;}
-.javascript .kw1 {color: #000066; font-weight: bold;}
-.javascript .kw2 {color: #003366; font-weight: bold;}
-.javascript .kw3 {color: #000066;}
-.javascript .co1 {color: #009900; font-style: italic;}
-.javascript .coMULTI {color: #009900; font-style: italic;}
-.javascript .es0 {color: #000099; font-weight: bold;}
-.javascript .br0 {color: #66cc66;}
-.javascript .st0 {color: #3366CC;}
-.javascript .nu0 {color: #CC0000;}
-.javascript .me1 {color: #006600;}
-.javascript .sc0 {}
-.javascript .sc1 {}
-.javascript .sc2 {}
-.javascript .sc3 {}
-.javascript .re0 {color: #0066FF;}
-/**
- * GeSHi Dynamically Generated Stylesheet
- * --------------------------------------
- * Dynamically generated stylesheet for javascript
- * CSS class: javascript, CSS id: 
- * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)
- */
-.javascript .de1, .javascript .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;}
-.javascript  {}
-.javascript .head {}
-.javascript .foot {}
-.javascript .imp {font-weight: bold; color: red;}
-.javascript .ln-xtra {color: #cc0; background-color: #ffc;}
-.javascript li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;}
-.javascript li.li2 {font-weight: bold;}
-.javascript .kw1 {color: #000066; font-weight: bold;}
-.javascript .kw2 {color: #003366; font-weight: bold;}
-.javascript .kw3 {color: #000066;}
-.javascript .co1 {color: #009900; font-style: italic;}
-.javascript .coMULTI {color: #009900; font-style: italic;}
-.javascript .es0 {color: #000099; font-weight: bold;}
-.javascript .br0 {color: #66cc66;}
-.javascript .st0 {color: #3366CC;}
-.javascript .nu0 {color: #CC0000;}
-.javascript .me1 {color: #006600;}
-.javascript .sc0 {}
-.javascript .sc1 {}
-.javascript .sc2 {}
-.javascript .sc3 {}
-.javascript .re0 {color: #0066FF;}
+.javascript .st0 {color: #ff0000;}
+.javascript .nu0 {color: #ff33ff;}
+.javascript .me0 {color: #006600;}
+
+.html4strict .de1, .html4strict .de2 {font-weight:normal;background:transparent;color:#000; padding-left: 5px;}
+.html4strict .kw1 {color: #a1a100;}
+.html4strict .kw2 {color: #000; font-weight: bold;}
+.html4strict .kw3 {color: #000066;}
+.html4strict .kw4 {color: #f63333;}
+.html4strict .co1, .html4strict .co2, .html4strict .coMULTI {color: #808080;}
+.html4strict .es0 {color: #000033; font-weight: bold;}
+.html4strict .br0 {color: #66cc66;}
+.html4strict .st0 {color: #ff0000;}
+.html4strict .nu0 {color: #ff33ff;}
+.html4strict .me0 {color: #006600;}

util/branches/dev/jsdoc/jsdoc.install

@@ -139 +139 @@
         parent_vid integer NOT NULL REFERENCES {node_revisions} (vid),
         parent_nid integer NOT NULL REFERENCES {node} (vid), -- node-type: jsdoc_variable
-        type enum('normal', 'prototype', 'instance', 'alias', 'chain', 'mixin'), -- The type of join
+        type enum('normal', 'cascading', 'prototype', 'instance', 'alias', 'chain', 'mixin'), -- The type of join
         subtype enum('call', 'prototype', '') DEFAULT '', -- The subtype of the join
         version integer NOT NULL REFERENCES {node} (nid), -- node-type: jsdoc_version
@@ -180 +180 @@
         weight integer NOT NULL,
         example longtext NOT NULL,
+        markedup longtext NOT NULL,
       PRIMARY KEY (vid, weight)
       ) /*!40100 DEFAULT CHARACTER SET UTF8 */ ");

util/branches/dev/jsdoc/jsdoc.module

@@ -407 +407 @@
     else {
       _jsdoc_init();
+
+      $ignores = array();
+      $query = db_query("SELECT parent.title FROM jsdoc_variable_hierarchy AS jvh JOIN node AS child ON (child.vid = jvh.vid) JOIN jsdoc_objects AS jschild ON (jschild.vid = jvh.nid) JOIN node AS parent ON (parent.vid = jvh.parent_vid) WHERE jvh.type NOT IN ('cascading', 'normal', 'alias') AND (parent.title LIKE 'dojo.%'  OR parent.title LIKE 'dojox.%' OR parent.title LIKE 'dijit.%') AND jschild.private = 0 AND jschild.private_parent = 0 GROUP BY BINARY parent.title ORDER BY parent.title");
+      while ($result = db_fetch_object($query)) {
+        $ignores[] = $result->title;
+      }
+      $namespaces = array();
+      $query = db_query("SELECT parent.title FROM jsdoc_variable_hierarchy AS jvh JOIN node AS child ON (child.vid = jvh.vid) JOIN jsdoc_objects AS jschild ON (jschild.vid = jvh.nid) JOIN node AS parent ON (parent.vid = jvh.parent_vid) WHERE jvh.type = 'normal' AND (parent.title LIKE 'dojo.%'  OR parent.title LIKE 'dojox.%' OR parent.title LIKE 'dijit.%') AND jschild.private = 0 AND jschild.private_parent = 0 GROUP BY BINARY parent.title ORDER BY parent.title");
+      while ($result = db_fetch_object($query)) {
+        $found = false;
+        foreach ($ignores as $ignore) {
+          if (strpos($ignore, $result->title . '.') === 0 || $ignore == $result->title) {
+            $found = true;
+            break;
+          }
+        }
+        if (!$found) {
+          $namespaces[] = $result->title;
+        }
+      }
+      cache_set('jsdoc_namespaces', 'cache', serialize($namespaces));
 
       $timestamp = variable_get('jsdoc_cron_time', 0);
@@ -995 +1016 @@
   if (is_array(jsdoc_get_examples($node))) {
     foreach (jsdoc_get_examples($node) as $weight => $example) {
-      $example = _jsdoc_markup_text($example, jsdoc_get_version($node)->nid);
-      db_query("INSERT INTO {jsdoc_examples} (vid, nid, weight, example) VALUES (%d, %d, %d, '%s')", $node->vid, $node->nid, $weight, $example);
+      $example = preg_replace('%^([\s]*)\n%', '', $example);
+      db_query("INSERT INTO {jsdoc_examples} (vid, nid, weight, example, markedup) VALUES (%d, %d, %d, '%s', '%s')", $node->vid, $node->nid, $weight, $example, _jsdoc_markup_text($example, jsdoc_get_version($node)->nid));
     }
   }
@@ -1030 +1051 @@
   if (is_array(jsdoc_get_examples($node))) {
     foreach (jsdoc_get_examples($node) as $weight => $example) {
-      $example = _jsdoc_markup_text($example, jsdoc_get_version($node)->nid);
-      db_query("INSERT INTO {jsdoc_examples} (vid, nid, weight, example) VALUES (%d, %d, %d, '%s')", $node->vid, $node->nid, $weight, $example);
+      $example = preg_replace('%^([\s]*)\n%', '', $example);
+      db_query("INSERT INTO {jsdoc_examples} (vid, nid, weight, example, markedup) VALUES (%d, %d, %d, '%s', '%s')", $node->vid, $node->nid, $weight, $example, _jsdoc_markup_text($example, jsdoc_get_version($node)->nid));
     }
   }
@@ -1341 +1362 @@
 }
 
-function jsdoc_get_examples(&$node) {
+function jsdoc_get_examples(&$node, $markedup=false) {
   if (isset($node->jsdoc_examples)) {
     return $node->jsdoc_examples;
@@ -1347 +1368 @@
 
   $node->jsdoc_examples = array();
-  $query = db_query("SELECT example FROM {jsdoc_examples} WHERE vid = %d ORDER BY weight", $node->vid);
+  $query = db_query("SELECT example, markedup FROM {jsdoc_examples} WHERE vid = %d ORDER BY weight", $node->vid);
   while ($example = db_fetch_object($query)) {
-    $node->jsdoc_examples[] = $example->example;
+    $node->jsdoc_examples[] = ($markedup) ? $example->markedup : $example->example;
   }
 
@@ -2306 +2327 @@
       }
     }
+  }
+
+  $examples = array();
+  foreach (jsdoc_get_examples($node, true) as $weight => $example) {
+    $examples[] = theme('jsdoc_object_example', $example, $weight + 1);
+  }
+  if (!empty($examples)) {
+    $form['examples'] = array(
+      '#value' => theme('jsdoc_object_examples', $examples),
+      '#weight' => 35
+    );
   }
 
@@ -2885 +2917 @@
       db_query("INSERT INTO {jsdoc_variable_hierarchy} (vid, nid, parent_vid, parent_nid, type, version) VALUES (%d, %d, %d, %d, '%s', %d)", $node->vid, $node->nid, $parent->vid, $parent->nid, 'instance', jsdoc_get_version($node)->nid);
       
-      // If object foo has function foo.bar and foo.bar uses the variable this.baz and is uninstantiated,
-      // `this` would refer to foo, making baz a property of foo
-      // So we create a normal join from foo.bar.baz to foo.baz by removing the second to last object section
-      if (preg_match('%^([^.]+)\.[^.]+\.([^.]+)$%', $node->jsdoc_instance, $match)) {
+      // If object foo has function foo.bar and foo.bar uses the variable
+      // this.baz and is uninstantiated, `this` would refer to foo,
+      // making baz a property of foo. So we create a normal join
+      // from foo.bar.baz to foo.baz by removing the second to last object section
+      if (preg_match('%^([^.]+)\.[^.]+\.([^.]+)$%', $node->title, $match)) {
         $parent = _jsdoc_variable_get_or_create($match[1] . '.' . $match[2], jsdoc_get_project($node), false);
-        db_query("INSERT INTO {jsdoc_variable_hierarchy} (vid, nid, parent_vid, parent_nid, type, version) VALUES (%d, %d, %d, %d, '%s', %d)", $node->vid, $node->nid, $parent->vid, $parent->nid, 'normal', jsdoc_get_version($node)->nid);
+        db_query("INSERT INTO {jsdoc_variable_hierarchy} (vid, nid, parent_vid, parent_nid, type, version) VALUES (%d, %d, %d, %d, '%s', %d)", $node->vid, $node->nid, $parent->vid, $parent->nid, 'cascading', jsdoc_get_version($node)->nid);
       }
     }
@@ -2920 +2953 @@
         }
       }
-    }    
+    }
     if ($node->jsdoc_chains) {
       foreach ($node->jsdoc_chains as $subtype => $chain) {
@@ -3388 +3421 @@
 
   _jsdoc_init();
-  $highlighter =& new GeSHi($text, 'javascript');
+  $language = 'javascript';
+  if (preg_match('%(^\W*<|>\W*$)%', $text)) {
+    $language = 'html4strict';
+    print $language;
+  }
+  $highlighter =& new GeSHi($text, $language);
   $highlighter->enable_classes();
+  $highlighter->enable_keyword_links(false);
   $highlighter->set_overall_style('color: #666;', true);
   $highlighter->set_tab_width(4);
@@ -3501 +3540 @@
     $format = variable_get('jsdoc_input_format', 1);
   }
-  
+
   $text = check_markup($text, $format, FALSE);
-  if (preg_match_all('%<code>(.*?)</code>%s', $text, $matches, PREG_SET_ORDER)) {
+  if (preg_match_all('%(?:\s*(?:<pre>|<code>)\s*)+(.*?)(?:\s*(?:</pre>|</code>)\s*)+%s', $text, $matches, PREG_SET_ORDER)) {
     foreach ($matches as $match) {
+      $match[1] = str_replace('&lt;', '<', str_replace('&gt;', '>', $match[1]));
       $text = str_replace($match[0], _jsdoc_markup_code($match[1], $version), $text);
     }
@@ -3701 +3741 @@
 function theme_jsdoc_function_parameters($parameters) {
   $output = '<div class="jsdoc_function_parameters">';
-  $output .= '<fieldset class="collapsible">';
+  $output .= '<fieldset>';
   $output .= '<legend>' . 'Parameters' . '</legend>';
   $output .= '<div class="fieldset-wrapper">';
@@ -3776 +3816 @@
   return $summary . $description;
 }
+
+function theme_jsdoc_object_example($example, $weight) {
+  return '<div class="form-item"><label>Example #' . $weight . '</label>' . $example . '</div>';
+}
+
+function theme_jsdoc_object_examples($examples) {
+  $output = '<div class="jsdoc_object_examples">';
+  $output .= '<fieldset>';
+  $output .= '<legend>Examples</legend>';
+  $output .= '<div class="fieldset-wrapper">';
+  $output .= implode('', $examples);
+  $output .= '</div></fieldset></div>';
+  return $output;
+}

util/trunk/docscripts/includes/dojo.inc

@@ -225 +225 @@
       $object->setName($name);
       $object->setAnonymous(true);
+      $object->addBlockCommentKeySet('example');
       $values = $object->getValues();
       foreach ($values as $key => $value) {
@@ -246 +247 @@
       $keys = $object->getBlockCommentKeys();
       foreach ($keys as $key) {
-        if ($key == 'summary') {
+        if ($key == 'example') {
+          $output[$name]['examples'] = $object->getBlockComment('example');
+        }
+        elseif ($key == 'summary') {
           $output[$name]['summary'] = $object->getBlockComment('summary');
         }

util/trunk/docscripts/lib/parser/DojoObject.php

@@ -48 +48 @@
     return $this->body->addBlockCommentKey($key);
   }
-  
+
+  public function addBlockCommentKeySet($key){
+    return $this->body->addBlockCOmmentKeySet($key);
+  }
+
   public function build(){
     if(!$this->start){