From acaaf55b118322d7edc80e401b20187cf6251683 Mon Sep 17 00:00:00 2001
From: Martin Smith <msmith@trolltech.com>
Date: Tue, 15 Dec 2009 17:05:35 +0100
Subject: doc: Final fix. Example image links now display the image.

Task-number: QTBUG-4484
---
 tools/qdoc3/generator.cpp     | 42 +++++++++++++++++++++++++++++++++++++++++-
 tools/qdoc3/generator.h       |  2 ++
 tools/qdoc3/htmlgenerator.cpp |  4 ++++
 3 files changed, 47 insertions(+), 1 deletion(-)

diff --git a/tools/qdoc3/generator.cpp b/tools/qdoc3/generator.cpp
index 95319ca..56fca06 100644
--- a/tools/qdoc3/generator.cpp
+++ b/tools/qdoc3/generator.cpp
@@ -65,6 +65,8 @@ QMap<QString, QStringList> Generator::imgFileExts;
 QSet<QString> Generator::outputFormats;
 QStringList Generator::imageFiles;
 QStringList Generator::imageDirs;
+QStringList Generator::exampleDirs;
+QStringList Generator::exampleImgExts;
 QString Generator::outDir;
 QString Generator::project;
 
@@ -120,12 +122,19 @@ void Generator::initialize(const Config &config)
         if (!dirInfo.mkdir(outDir + "/images"))
             config.lastLocation().fatal(tr("Cannot create output directory '%1'")
                                         .arg(outDir + "/images"));
+        if (!dirInfo.mkdir(outDir + "/images/used-in-examples"))
+            config.lastLocation().fatal(tr("Cannot create output directory '%1'")
+                                        .arg(outDir + "/images/used-in-examples"));
     }
 
     imageFiles = config.getStringList(CONFIG_IMAGES);
     imageDirs = config.getStringList(CONFIG_IMAGEDIRS);
+    exampleDirs = config.getStringList(CONFIG_EXAMPLEDIRS);
+    exampleImgExts = config.getStringList(CONFIG_EXAMPLES + Config::dot +
+                                          CONFIG_IMAGEEXTENSIONS);
 
-    QString imagesDotFileExtensions = CONFIG_IMAGES + Config::dot + CONFIG_FILEEXTENSIONS;
+    QString imagesDotFileExtensions =
+        CONFIG_IMAGES + Config::dot + CONFIG_FILEEXTENSIONS;
     QSet<QString> formats = config.subVars(imagesDotFileExtensions);
     QSet<QString>::ConstIterator f = formats.begin();
     while (f != formats.end()) {
@@ -530,6 +539,13 @@ void Generator::generateInheritedBy(const ClassNode *classe,
     }
 }
 
+/*!
+  This function is called when the documentation for an
+  example is being formatted. It outputs the list of source
+  files comprising the example, and the list of images used
+  by the example. The images are copied into a subtree of
+  \c{...doc/html/images/used-in-examples/...} 
+ */
 void Generator::generateFileList(const FakeNode* fake,
                                  CodeMarker* marker,
                                  Node::SubType subtype,
@@ -546,6 +562,30 @@ void Generator::generateFileList(const FakeNode* fake,
         if (child->subType() == subtype) {
             ++count;
             QString file = child->name();
+            if (subtype == Node::Image) {
+                if (!file.isEmpty()) {
+                    QDir dirInfo;
+                    QString userFriendlyFilePath;
+                    QString srcPath = Config::findFile(fake->location(),
+                                                       QStringList(),
+                                                       exampleDirs,
+                                                       file,
+                                                       exampleImgExts,
+                                                       userFriendlyFilePath);
+                    userFriendlyFilePath.truncate(userFriendlyFilePath.lastIndexOf('/'));
+
+                    QString imgOutDir = outDir + "/images/used-in-examples/" + userFriendlyFilePath;
+                    if (!dirInfo.mkpath(imgOutDir))
+                        fake->location().fatal(tr("Cannot create output directory '%1'")
+                                               .arg(imgOutDir));
+
+                    QString imgOutName = Config::copyFile(fake->location(),
+                                                          srcPath,
+                                                          file,
+                                                          imgOutDir);
+                }
+
+            }
 
             openedList.next();
             text << Atom(Atom::ListItemNumber, openedList.numberString())
diff --git a/tools/qdoc3/generator.h b/tools/qdoc3/generator.h
index 7667789..cc1ea25 100644
--- a/tools/qdoc3/generator.h
+++ b/tools/qdoc3/generator.h
@@ -183,6 +183,8 @@ class Generator
     static QSet<QString> outputFormats;
     static QStringList imageFiles;
     static QStringList imageDirs;
+    static QStringList exampleDirs;
+    static QStringList exampleImgExts;
     static QString outDir;
     static QString project;
 };
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index 8711c6b..ae7bd81 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -3429,6 +3429,8 @@ QString HtmlGenerator::fileName(const Node *node)
     if (node->type() == Node::Fake) {
         if (static_cast<const FakeNode *>(node)->subType() == Node::ExternalPage)
             return node->name();
+        if (static_cast<const FakeNode *>(node)->subType() == Node::Image)
+            return node->name();
     }
     return PageGenerator::fileName(node);
 }
@@ -4000,6 +4002,8 @@ QString HtmlGenerator::getLink(const Atom *atom,
 
         if (path.isEmpty()) {
             link = linkForNode(*node, relative);
+            if (*node && (*node)->subType() == Node::Image)
+                link = "images/used-in-examples/" + link;
             if (targetAtom)
                 link += "#" + refForAtom(targetAtom, *node);
         }
-- 
cgit v0.12