diff options
author | Miklos Vajna <vmiklos@collabora.co.uk> | 2014-01-27 20:10:52 +0100 |
---|---|---|
committer | Miklos Vajna <vmiklos@collabora.co.uk> | 2014-01-27 20:19:15 +0100 |
commit | 1cfb281c2daafcdefe5404f51037c72f9b57dde8 (patch) | |
tree | fcd0977c63bc383aac4af0f2907225d29592a97a | |
parent | 4520e37785c485e7a29a069c32d91832c59a95bc (diff) |
remove script that parsed no longer available WRITERFILTERSTATUS comments
Change-Id: I137d2a9e4c0edda3e2509696ba4b0f5f4913bbc3
-rw-r--r-- | writerfilter/source/ooxml/README.efforts | 149 | ||||
-rw-r--r-- | writerfilter/source/ooxml/status.sh | 41 |
2 files changed, 0 insertions, 190 deletions
diff --git a/writerfilter/source/ooxml/README.efforts b/writerfilter/source/ooxml/README.efforts deleted file mode 100644 index 4448912f5911..000000000000 --- a/writerfilter/source/ooxml/README.efforts +++ /dev/null @@ -1,149 +0,0 @@ -# -# This file is part of the LibreOffice project. -# -# This Source Code Form is subject to the terms of the Mozilla Public -# License, v. 2.0. If a copy of the MPL was not distributed with this -# file, You can obtain one at http://mozilla.org/MPL/2.0/. -# -# This file incorporates work covered by the following license notice: -# -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed -# with this work for additional information regarding copyright -# ownership. The ASF licenses this file to you under the Apache -# License, Version 2.0 (the "License"); you may not use this file -# except in compliance with the License. You may obtain a copy of -# the License at http://www.apache.org/licenses/LICENSE-2.0 . -# - -This file describes how the remaining efforts for writerfilter can be -extracted from the source code. - -1. Marking up the efforts in the code. - -Efforts are marked up in the code with comments like this: - -/* WRITERFILTERSTATUS: done: <percent done>, planned: <effort planned>, spent: <effort spent, yet> */ - -The comments have to follow a case-label immediately. Consecutive -case-labels can be marked up, too. In the latter case the efforts are -counted for the preceeding case-labels as a whole. - -2. Extraction process - -2.1. Stage 1: - -This stage is handled in status.sh. An XML-file is generated that -contains a top level element <stage1>. <stage1> contains an element -<analyze> and several <qname> and <status> elements. - -2.1.1. Use analyzemodel.xsl to extract necessary data from model.xml. - -- Namespaces can be flagged with attribute @todo="ignore" to prevent - the namespace being considered. - -- For every <element>/<attribute> an entry in an according element in <analyze> is genereated. These elements look like this: - -<attribute id="..." resource="..." tokenid="..." qname="..." namespace="..." define="..." name="..."/> - -Important for the extraction of efforts: @qname is the identifier used -in case-labels in .cxx files and thus links the status mark up -comments with elements/attributes in the model.xml. - -2.1.2. Extract status information - -The variable SEARCHIN in status.sh determines in what directory the script will search for case labels and status comments. Only .cxx files are searched. Lines like this - -case NS_rtf::LN_UNUSED4: - -result in elements like this - -<qname file="/DomainMapper.cxx" line="216" qname="NS_rtf::LN_UNUSED4"/>. - -Lines like this - -/* WRITERFILTERSTATUS: done: 0, planned: 0, spent: 0 */ - -result in elements like this - -<status done="0" planned="0" spent="0"/> - -The <qname> and <status> elements are children of the <stage1> -element. The are inserted in the same order as found in the -code. Therefore a <status> element corresponds to the group of -consecutive preceding <qname> elements. - -2.2. Stage 2 - -In this stage analyzestage2.xsl is used on the result of stage 1 to -group the <qname> and <status> elements from stage 1. For each -<status> element a <qnames> element is generated that contains the -<qname> elements that the <status> element refers to, plus the -<status> element. - -2.3. Stage 3 - -This stage associates the <attribute> and <element> elements in -model.xml with the extracted data. It uses analyzestage3.xsl on the -result of stage 2 to do this. - -E.g. for given elements from stage 2: - -<attribute - id="dml-wordprocessingDrawing:CT_Inline:distR" - resource="Properties" - tokenid="ooxml:CT_Inline_distR" - qname="NS_ooxml::LN_CT_Inline_distR" - namespace="dml-wordprocessingDrawing" - define="CT_Inline" - name="distR"/> - -and - - <qnames> - <qname file="/GraphicImport.cxx" line="1078" qname="NS_ooxml::LN_CT_Inline_distT"/> - <qname file="/GraphicImport.cxx" line="1079" qname="NS_ooxml::LN_CT_Inline_distB"/> - <qname file="/GraphicImport.cxx" line="1080" qname="NS_ooxml::LN_CT_Inline_distL"/> - <qname file="/GraphicImport.cxx" line="1081" qname="NS_ooxml::LN_CT_Inline_distR"/> - <status done="0" planned="0.5" spent="0"/> - </qnames> - -the result of stage 3 will be - - <attribute - id="dml-wordprocessingDrawing:CT_Inline:distR" - resource="Properties" - tokenid="ooxml:CT_Inline_distR" - qname="NS_ooxml::LN_CT_Inline_distR" - namespace="dml-wordprocessingDrawing" - define="CT_Inline" name="distR"> - - <file name="/GraphicImport.cxx" line="1081"> - <status done="0" planned="0.5" spent="0" qname-count="4"/> - </file> - - </attribute> - -@qname-count is the number of case-labels that the according mark-up comment refers to. - -3. Collect efforts - -This is done by the script efforts.sh. It uses status.sh to extract the status and determines the efforts in two steps. - -3.1. Choose which <attribute>/<element> elements need effort - -This stage uses todo.xsl on the result of 2.3. - -There are two criteria that imply effort: - -- The <attribute>/<element> is not handled in any file. - -- The status for the <attribute>/<element> declares that work is - planned for it and less than 100 percent of this work is done. - -3.2. Generate table of efforts in CSV format - -This stage uses effort.xsl on the results of 3.1. and produces the -table of efforts. If there is no status defined for an -<attribute>/<element> it is assumed that the planned effort is 0.5 -hours and no work has been done. diff --git a/writerfilter/source/ooxml/status.sh b/writerfilter/source/ooxml/status.sh deleted file mode 100644 index 42ec08dc47f9..000000000000 --- a/writerfilter/source/ooxml/status.sh +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/sh -# -# This file is part of the LibreOffice project. -# -# This Source Code Form is subject to the terms of the Mozilla Public -# License, v. 2.0. If a copy of the MPL was not distributed with this -# file, You can obtain one at http://mozilla.org/MPL/2.0/. -# -# This file incorporates work covered by the following license notice: -# -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed -# with this work for additional information regarding copyright -# ownership. The ASF licenses this file to you under the Apache -# License, Version 2.0 (the "License"); you may not use this file -# except in compliance with the License. You may obtain a copy of -# the License at http://www.apache.org/licenses/LICENSE-2.0 . -# - -SEARCHIN=$SRC_ROOT/writerfilter/source/dmapper - -( -echo '<?xml version="1.0"?>' -echo "<stage1>" - -xsltproc analyzemodel.xsl model.xml | tail -n +2 - -find $SEARCHIN -name "*.cxx" -exec grep -nH -A 1 "case NS_" {} \; | -grep -v "//.*case NS_" | -sed 's#'$SEARCHIN'##' | -sed 's#\(^[^:]*\):\([0-9]*\):#<qname file="\1" line="\2"#' | -sed 's#[/* ]*case \(NS_.*\):.*# qname="\1"/>#' | -sed 's#.*WRITERFILTERSTATUS: done: \([0-9]*\), planned: \([0-9.]*\), spent: \([0-9.]*\).*#<status done="\1" planned="\2" spent="\3"/>#' | -sed 's#.*WRITERFILTERSTATUS:.*#<status done="100"/>#' | -sed 's#^.*-[0-9][0-9]*-.*$#<nostatus/>#' | -grep -v "^--" - -echo "</stage1>" -) | -xsltproc analyzestage2.xsl - | -xsltproc analyzestage3.xsl - |