From 5fe30fbe079f37443857e720550e939b7dd988e6 Mon Sep 17 00:00:00 2001 From: xue <> Date: Thu, 29 Jun 2006 20:27:48 +0000 Subject: Added Dreamweaver extension generator. --- .gitattributes | 2 + HISTORY | 1 + build.xml | 27 ++- buildscripts/classtree/DWExtension.php | 255 +++++++++++++++++++++++++++ buildscripts/classtree/DWExtensionReadme.txt | 22 +++ buildscripts/classtree/build.php | 93 ++++++++-- index.html | 68 +++---- 7 files changed, 422 insertions(+), 46 deletions(-) create mode 100644 buildscripts/classtree/DWExtension.php create mode 100644 buildscripts/classtree/DWExtensionReadme.txt diff --git a/.gitattributes b/.gitattributes index 36cd59d4..1c884672 100644 --- a/.gitattributes +++ b/.gitattributes @@ -310,6 +310,8 @@ buildscripts/PhpDocumentor/user/error.ini -text buildscripts/PhpDocumentor/user/pear-makedocs.ini -text buildscripts/PhpDocumentor/user/prado.ini -text buildscripts/PhpDocumentor/user/testdocbook.ini -text +buildscripts/classtree/DWExtension.php -text +buildscripts/classtree/DWExtensionReadme.txt -text buildscripts/classtree/build.php -text buildscripts/index/api_index.php -text buildscripts/index/build.php -text diff --git a/HISTORY b/HISTORY index 3fa0bc00..72829f59 100644 --- a/HISTORY +++ b/HISTORY @@ -21,6 +21,7 @@ ENH: Added TPageService.BasePageClass property (Qiang) ENH: Added TDataGrid.EmptyTemplate property (Qiang) ENH: Added paging feature to all TDataBoundControl-derived controls (Qiang) NEW: Added TPager (Qiang) +NEW: Added Dreamweaver taglib extension (Stanislav, Qiang) Version 3.0.1 June 4, 2006 ========================== diff --git a/build.xml b/build.xml index a85b64d0..9212e20b 100644 --- a/build.xml +++ b/build.xml @@ -132,6 +132,8 @@ + + Changing file permissions... @@ -221,7 +223,30 @@ - + + + + + + Distribution Not Completed Yet!!! + +The following steps need to be manually performed in order to complete +the PRADO distribution: + +1. Package DreamWeaver extension by running DW extension manager with + buildscripts/classtree/PRADO.mxi and saving the generated file as + "${build.src.dir}/editors/Dreamweaver/PRADO.mxp" + +2. If building on Linux, the CHM doc file needs to be generated by compiling + "${build.doc.dir}/manual/CHMdefaultConverter/phpdoc.hhp" + and saving the generated file as + "${build.src.dir}/docs/manual.chm" + +3. Use winzip (on Windows) and gzip (on Linux) to generate the compressed + release files of the direcotry + "${build.src.dir}". + + diff --git a/buildscripts/classtree/DWExtension.php b/buildscripts/classtree/DWExtension.php new file mode 100644 index 00000000..f85f100d --- /dev/null +++ b/buildscripts/classtree/DWExtension.php @@ -0,0 +1,255 @@ + + * @author Qiang Xue + */ +class PradoVTMDocument +{ + private $_document; + private $_attributes; + + public function __construct($controlName) + { + $this->_document = new DOMDocument('1.0', 'utf-8'); + $this->prepareDocument($controlName); + } + + protected function prepareDocument($controlName) + { + $this->_document->formatOutput = true; + + //--- add + $tag = $this->_document->createElement('tag'); + $tag->setAttribute('name',$controlName); + $tag->setAttribute('casesensitive','yes'); + $this->_document->appendChild($tag); + + //--- add + $tagFormat = $this->_document->createElement('tagformat'); + $tagFormat->setAttribute('nlbeforetag','1'); + $tagFormat->setAttribute('nlaftertag','1'); + $tagFormat->setAttribute('indentcontents','yes'); + $tag->appendChild($tagFormat); + + //--- add + //$tagDialog = $this->_document->createElement('tagdialog'); + //$tagDialog->setAttribute('file',$controlName.'.htm'); + //$tag->appendChild($tagDialog); + + $this->_attributes = $this->_document->createElement('attributes'); + $tag->appendChild($this->_attributes); + } + + public function getDocument() + { + return $this->_document; + } + + public function addAttribute($attribName, $attribType) + { + //--- add + $attrib = $this->_document->createElement('attrib'); + $attrib->setAttribute('name',$attribName); + if (is_array($attribType)) + { + $attrib->setAttribute('type','Enumerated'); + foreach ($attribType as $value) + { + $option = $this->_document->createElement('attriboption'); + $option->setAttribute('value',$value); + $option->setAttribute('caption',''); + $attrib->appendChild($option); + } + } + else if($attribType!=='') + { + $attrib->setAttribute('type',$attribType); + } + $attrib->setAttribute('casesensitive','yes'); + $this->_attributes->appendChild($attrib); + } + + public function addEvent($eventName) + { + //--- add + $this->addAttribute($eventName,''); + //--- add + $event = $this->_document->createElement('event'); + $event->setAttribute('name',$eventName); + $this->_attributes->appendChild($event); + } + + public function getXML() + { + return $this->_document->saveXML(); + } +} + +/** + * PradoMXIDocument class + * + * @author Stanislav Yordanov + * @author Qiang Xue + */ +class PradoMXIDocument +{ + private $_tagLibraryElement; + private $_filesElement; + private $_document; + + public function __construct($version) + { + $this->_document = new DOMDocument('1.0', 'utf-8'); + $this->prepareDocument($version); + } + + protected function prepareDocument($version) + { + $this->_document->formatOutput = true; + //--- add root element + $rootElement = $this->_document->createElement('macromedia-extension'); + $rootElement->setAttribute('name','PRADO Taglib'); + $rootElement->setAttribute('version',$version); + $rootElement->setAttribute('type','Suite'); + $rootElement->setAttribute('requires-restart','true'); + $this->_document->appendChild($rootElement); + //--- add + $element = $this->_document->createElement('author'); + $element->setAttribute('name','Stanislav Yordanov, Qiang Xue'); + $rootElement->appendChild($element); + $time = date('F j, Y, h:i:s a',time()); + //--- add + $description = << and Qiang Xue +Time: $time +Requirement: Macromedia Dreamweaver MX/MX 2004/8.0 or above +Description: This suite adds PRADO tag library. The tag library contains PRADO component +tags, properties and events that are commonly used on PRADO templates. +EOD; + $element = $this->_document->createElement('description'); + $element->appendChild($this->_document->createCDATASection($description)); + $rootElement->appendChild($element); + //--- add + $productsElement = $this->_document->createElement('products'); + $rootElement->appendChild($productsElement); + //--- add + $product = $this->_document->createElement('product'); + $product->setAttribute('name','Dreamweaver'); + $product->setAttribute('version','6'); + $product->setAttribute('primary','false'); + $productsElement->appendChild($product); + //--- add + $element = $this->_document->createElement('ui-access'); + $element->appendChild($this->_document->createCDATASection("PRADO")); + $rootElement->appendChild($element); + //--- add + $this->_filesElement = $this->_document->createElement('files'); + $rootElement->appendChild($this->_filesElement); + //--- add + $configChangeElement = $this->_document->createElement('configuration-changes'); + $rootElement->appendChild($configChangeElement); + //--- add + $tagLibChangeElement = $this->_document->createElement('taglibrary-changes'); + $configChangeElement->appendChild($tagLibChangeElement); + //--- add + $tagLibInsertElement = $this->_document->createElement('taglibrary-insert'); + $tagLibChangeElement->appendChild($tagLibInsertElement); + //--- add + $this->_tagLibraryElement = $element = $this->_document->createElement('taglibrary'); + $element->setAttribute('doctypes','HTML,DWTemplate'); + $element->setAttribute('id','DWTagLibrary_PRADO_tags'); + $element->setAttribute('name','PRADO tags'); + $element->setAttribute('prefix','setAttribute('tagchooser','PRADO/TagChooser.xml'); + $tagLibInsertElement->appendChild($element); + + $element = $this->_document->createElement('file'); + $element->setAttribute('name','Configuration/TagLibraries/PRADO/TagChooser.xml'); + $element->setAttribute('destination','$dreamweaver/Configuration/TagLibraries/PRADO/TagChooser.xml'); + $this->_filesElement->appendChild($element); + } + + public function addTag($tagName) + { + $element = $this->_document->createElement('file'); + $element->setAttribute('name','Configuration/TagLibraries/PRADO/'.$tagName.'.vtm'); + $element->setAttribute('destination','$dreamweaver/Configuration/TagLibraries/PRADO/'.$tagName.'.vtm'); + $this->_filesElement->appendChild($element); + + $element = $this->_document->createElement('tagref'); + $element->setAttribute('file','PRADO/'.$tagName.'.vtm'); + $element->setAttribute('name',$tagName); + $this->_tagLibraryElement->appendChild($element); + } + + public function getDocument() + { + return $this->_document; + } + + public function getXML() + { + return $this->_document->saveXML(); + } +} + +/** + * PradoTagChooser class + * + * @author Stanislav Yordanov + * @author Qiang Xue + */ +class PradoTagChooser +{ + private $_document; + private $_tclibrary; + private $_category; + + public function __construct() + { + $this->_document = new DOMDocument('1.0', 'utf-8'); + $this->prepareDocument(); + } + + protected function prepareDocument() + { + $this->_document->standalone = true; + $this->_document->formatOutput = true; + $tclibrary = $this->_document->createElement('tclibrary'); + $tclibrary->setAttribute('name','PRADO tags'); + $tclibrary->setAttribute('desc','A collection of all PRADO tags.'); + $tclibrary->setAttribute('reference','PRADO'); + $this->_document->appendChild($tclibrary); + + $this->_category = $this->_document->createElement('category'); + $this->_category->setAttribute('name','General'); + $this->_category->setAttribute('icon','Configuration/TagLibraries/Icons/Elements.gif'); + $tclibrary->appendChild($this->_category); + } + + public function addElement($elementName) + { + $element = $this->_document->createElement('element'); + $element->setAttribute('name','com:'.$elementName); + $element->setAttribute('value',''); + $element->setAttribute('reference','PRADO,COM:'.strtoupper($elementName)); + $this->_category->appendChild($element); + } + + public function getXML() + { + $this->_document->normalize(); + /* + $resultXML = $this->_document->saveXML(); + $resultXML = str_replace('>','>',$resultXML); + $resultXML = str_replace('<','<',$resultXML); + return $resultXML; + */ + return $this->_document->saveXML(); + } +} +?> \ No newline at end of file diff --git a/buildscripts/classtree/DWExtensionReadme.txt b/buildscripts/classtree/DWExtensionReadme.txt new file mode 100644 index 00000000..e273abd6 --- /dev/null +++ b/buildscripts/classtree/DWExtensionReadme.txt @@ -0,0 +1,22 @@ +This directory contains the Macromedia Dreamweaver Extension for PRADO. + +This PRADO extension contains a tag library that enables Dreamweaver to +auto-complete PRADO component tags when you use it to edit PRADO templates. + +Before installation, make sure you have uninstalled any older versions +of the PRADO extension. + +To install this extension, run Dreamweaver's extension manager program and +select the file PRADO.mxp to install. + +After installation, restart Dreamweaver. Open a new HTML document and start typing +in PRADO component tags. You will see as you are typing, a dropdown list may +pop up which contains the available component names, properties and events. +Some property types are also handled. + +This extension is tested with Dreamweaver 2004 MX. Please let me know if you find it +working on other versions. + +Enjoy! + +Qiang diff --git a/buildscripts/classtree/build.php b/buildscripts/classtree/build.php index bc95d1c8..d7f74828 100644 --- a/buildscripts/classtree/build.php +++ b/buildscripts/classtree/build.php @@ -1,7 +1,10 @@ buildTree(); -$a->saveToFile('classes.data'); +$a->saveToFile($basePath.'/classes.data'); +$a->saveAsDWExtension($basePath); class ClassTreeBuilder { const REGEX_RULES='/^\s*(abstract\s+)?class\s+(\w+)(\s+extends\s+(\w+)\s*|\s*)/msS'; - private $_basePath; + private $_frameworkPath; private $_exclusions; private $_classes=array(); - public function __construct($basePath,$exclusions) + public function __construct($frameworkPath,$exclusions) { - $this->_basePath=realpath($basePath); + $this->_frameworkPath=realpath($frameworkPath); $this->_exclusions=array(); foreach($exclusions as $exclusion) { if($exclusion[0]==='/') - $this->_exclusions[realpath($basePath.'/'.$exclusion)]=true; + $this->_exclusions[realpath($frameworkPath.'/'.$exclusion)]=true; else $this->_exclusions[$exclusion]=true; } @@ -37,7 +41,7 @@ class ClassTreeBuilder public function buildTree() { - $sourceFiles=$this->getSourceFiles($this->_basePath); + $sourceFiles=$this->getSourceFiles($this->_frameworkPath); foreach($sourceFiles as $sourceFile) $this->parseFile($sourceFile); ksort($this->_classes); @@ -73,7 +77,7 @@ class ClassTreeBuilder protected function parseFile($sourceFile) { include_once($sourceFile); - $classFile=strtr(substr($sourceFile,strlen($this->_basePath)),'\\','/'); + $classFile=strtr(substr($sourceFile,strlen($this->_frameworkPath)),'\\','/'); echo "Parsing $classFile...\n"; $content=file_get_contents($sourceFile); if(preg_match('/@package\s+([\w\.]+)\s*/msS',$content,$matches)>0) @@ -175,8 +179,75 @@ class ClassTreeBuilder return $files; } - public function saveAsTagLib($fileName) + public function saveAsDWExtension($basePath) + { + $tagPath=$basePath.'/Configuration/TagLibraries/PRADO'; + + // prepare the directory to save tag lib + @mkdir($basePath.'/Configuration'); + @mkdir($basePath.'/Configuration/TagLibraries'); + @mkdir($basePath.'/Configuration/TagLibraries/PRADO'); + + $docMXI = new PradoMXIDocument(Prado::getVersion()); + $tagChooser = new PradoTagChooser; + + $controlClass = new ReflectionClass('TControl'); + + foreach($this->_classes as $className=>$classInfo) + { + $class = new ReflectionClass($className); + if($class->isInstantiable() && ($className==='TControl' || $class->isSubclassOf($controlClass))) + { + $docMXI->addTag($className); + $tagChooser->addElement($className); + $docVTM = new PradoVTMDocument($className); + foreach($classInfo['Properties'] as $name=>$property) + { + $type=$property['type']; + if(isset($this->_classes[$type]) && ($type==='TFont' || strrpos($type,'Style')===strlen($type)-5 && $type!=='TStyle')) + $this->processObjectType($type,$this->_classes[$type],$name,$docVTM); + if($property['readonly'] || $property['protected']) + continue; + if(($type=$this->checkType($className,$name,$property['type']))!=='') + $docVTM->addAttribute($name,$type); + } + foreach($classInfo['Events'] as $name=>$event) + { + $docVTM->addEvent($name); + } + file_put_contents($tagPath.'/'.$className.'.vtm',$docVTM->getXML()); + } + } + + file_put_contents($basePath.'/PRADO.mxi',$docMXI->getXML()); + file_put_contents($tagPath.'/TagChooser.xml',$tagChooser->getXML()); + + } + + private function processObjectType($objectType,$objectInfo,$prefix,$doc) + { + foreach($objectInfo['Properties'] as $name=>$property) + { + if($property['type']==='TFont') + $this->processObjectType('TFont',$this->_classes['TFont'],$prefix.'.'.$name,$doc); + if($property['readonly'] || $property['protected']) + continue; + if(($type=$this->checkType($objectType,$name,$property['type']))!=='') + $doc->addAttribute($prefix.'.'.$name,$type); + } + } + + private function checkType($className,$propertyName,$type) { + if(strrpos($propertyName,'Color')===strlen($propertyName)-5) + return 'color'; + if($propertyName==='Style') + return 'style'; + if($type==='boolean') + return array('true','false'); + if($type==='string' || $type==='integer' || $type==='ITemplate') + return 'text'; + return ''; } } diff --git a/index.html b/index.html index 448eaae2..1294883d 100644 --- a/index.html +++ b/index.html @@ -59,6 +59,13 @@ The installation is done! You will see the following subdirectories,
  • Personal Website (incomplete)
    • +

    Editor Support

    +

    +A Macromedia Dreamweaver extension can be found under editors/Dreamweaver. +This extension contains a tag library that enables Dreamweaver to auto-complete +PRADO component tags when you use it to edit PRADO templates. +

    +

    Documentation

    • API documentation
      • @@ -97,6 +104,7 @@ The installation is done! You will see the following subdirectories,

      Special Credits To

        +
      • Stanislav Yordanov - the script of generating Dreameweaver extension for PRADO
      • All PRADO users - great suggestions, feedback and support
      • ASP.NET 2.0 for its great inspiration and reference
      • All third-party work used in PRADO
        • @@ -104,47 +112,39 @@ The installation is done! You will see the following subdirectories,

        License

        -

        PRADO is free software released under the terms of the following BSD license. +

        +The PRADO framework and the included demos are freeware. They are released under +the terms of the following BSD License.

        -

        Copyright © 2004-2006, PradoSoft (http://www.pradosoft.com)
        +

        +Copyright 2004-2006 by The PRADO Group (http://www.pradosoft.com)
        All rights reserved.

        -Redistribution and use in source and binary forms, -with or without modification, are permitted provided -that the following conditions are met: +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 developer nor the names of - its contributors may be used to endorse or promote - products derived from this software without specific - prior written permission.
          • +
        • 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 PRADO Group 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. +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.

        -- cgit v1.2.3