Changeset 5711

Timestamp:

05/01/09 19:56:36 (3 years ago)

Author:

westram

Message:

• can show *.pdf from ARB help (done same way as *ps)
• arb.ps -> arb.pdf
• help history
  • wrap around
  • dont add pages twice
  • get_full_qualified_help_file_name now returns "" if helpfilename is "" (previously return help directory, which was added to help history then)
  • do not delete help-history when a 'HELP' button is pressed

Location:

trunk

Files:

• ARBDB/ad_prot.h (modified) (1 diff)
• ARBDB/adsocket.c (modified) (2 diffs)
• HELP_SOURCE/arb_help2xml.cxx (modified) (1 diff)
• HELP_SOURCE/oldhelp/arb.hlp (modified) (1 diff)
• HELP_SOURCE/oldhelp/arb.pdf.gz (added)
• HELP_SOURCE/oldhelp/arb.ps.gz (deleted)
• HELP_SOURCE/oldhelp/arb_envar.hlp (modified) (2 diffs)
• HELP_SOURCE/oldhelp/consensus.ps.gz (modified) (1 prop) (previous)
• HELP_SOURCE/oldhelp/pos_variability.ps.gz (modified) (1 prop) (previous)
• HELP_SOURCE/oldhelp/rna3d_general.hlp (modified) (1 diff)
• HELP_SOURCE/oldhelp/rna3d_manual.pdf.gz (modified) (1 prop) (previous)
• HELP_SOURCE/oldhelp/rna3d_manual.ps.gz (deleted)
• HELP_SOURCE/to_help.xsl (modified) (2 diffs)
• HELP_SOURCE/to_html.xsl (modified) (2 diffs)
• WINDOW/AW_status.cxx (modified) (6 diffs)
• WINDOW/aw_window.hxx (modified) (1 diff)

trunk/ARBDB/ad_prot.h

@@ -291 +291 @@
 GB_CSTR GB_getenvPATH P_((void));
 GB_CSTR GB_getenvARB_GS P_((void));
+GB_CSTR GB_getenvARB_PDFVIEW P_((void));
 GB_CSTR GB_getenvARB_TEXTEDIT P_((void));
 GB_CSTR GB_getenvDOCPATH P_((void));

trunk/ARBDB/adsocket.c

@@ -1048 +1048 @@
 }
 
+GB_CSTR GB_getenvARB_PDFVIEW(void) {
+    static const char *pdfview = 0;
+    if (!pdfview) {
+        pdfview = getenv_executable("ARB_PDFVIEW"); // doc in arb_envar.hlp
+        if (!pdfview) pdfview = GB_find_executable("PDF viewer", "epdfview", "xpdf", "kpdf", "acroread", "gv", NULL);
+    }
+    return pdfview;
+}
+
 GB_CSTR GB_getenvARB_TEXTEDIT(void) {
     static const char *editor = 0;
@@ -1087 +1096 @@
         if (strcmp(env, "ARBHOME")      == 0) return GB_getenvARBHOME();
         if (strcmp(env, "ARB_GS")       == 0) return GB_getenvARB_GS();
+        if (strcmp(env, "ARB_PDFVIEW")  == 0) return GB_getenvARB_PDFVIEW();
         if (strcmp(env, "ARB_DOC")      == 0) return GB_getenvDOCPATH();
         if (strcmp(env, "ARB_TEXTEDIT") == 0) return GB_getenvARB_TEXTEDIT();

trunk/HELP_SOURCE/arb_help2xml.cxx

@@ -373 +373 @@
     // cuts off the '.hlp'
     size_t pos   = s.find(".hlp");
-    if ((pos+4) != s.length()) {
-        pos          = s.find(".ps");
-        if ((pos+3) == s.length()) return s; // accept .ps
-        throw string("Expected extension .hlp");
-    }
-    return string(s, 0, s.length()-4);
+    if ((pos+4) == s.length()) {
+        return string(s, 0, s.length()-4);
+    }
+
+    pos = s.find(".ps");
+    if ((pos+3) == s.length()) {
+        return s; // accept .ps
+    }
+
+    pos = s.find(".pdf");
+    if ((pos+4) == s.length()) {
+        return s; // accept .pdf
+    }
+    
+    throw string("Expected extension .hlp");
 }
 inline void check_duplicates(const string& link, const char */*where*/, const Links& existing, bool add_warnings) {

trunk/HELP_SOURCE/oldhelp/arb.hlp

@@ -6 +6 @@
 UP      arb_commands.hlp
 UP      copyright.hlp
-UP      arb.ps
+UP      arb.pdf
 UP      changes.hlp
 

trunk/HELP_SOURCE/oldhelp/arb_envar.hlp

@@ -64 +64 @@
                             (default: 'gv' or 'ghostview')
 
+                    ARB_PDFVIEW
+
+                            name of pdf viewer used by ARB
+                            (default: 'epdfview' or 'acroread' or 'gv')
+
                     ARB_WORKDIR
 
@@ -71 +76 @@
                     ARB_DOC
 
-                            directory where ARB searches for *.ps or *.ps.gz
-                            (default: $ARBHOME/lib/help)
+                            directory where ARB searches for *.ps, *.ps.gz, *.pdf
+                            and *.pdf.gz (default: $ARBHOME/lib/help)
 
 NOTES           Short description of how to set an environment variable:

trunk/HELP_SOURCE/oldhelp/rna3d_general.hlp

@@ -2 +2 @@
 UP      arb.hlp
 UP      glossary.hlp
-UP  rna3d_manual.ps
+UP      rna3d_manual.pdf
 
 #Please insert subtopic references  (line starts with keyword SUB)
 #SUB    subtopic.hlp
-SUB rna3d_dispMolecule.hlp
-SUB rna3d_dispBases.hlp
-SUB rna3d_dispHelices.hlp
-SUB rna3d_mapSeqData.hlp
+SUB     rna3d_dispMolecule.hlp
+SUB     rna3d_dispBases.hlp
+SUB     rna3d_dispHelices.hlp
+SUB     rna3d_mapSeqData.hlp
 
 # Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}

trunk/HELP_SOURCE/to_help.xsl

@@ -96 +96 @@
     <xsl:choose>
       <xsl:when test="string-length(substring-before($doc,'.ps'))&gt;0"> <!--it's a postscript link-->
-        <value-of select="{concat($postscriptpath,$doc,'.gz')}"/>
+        <xsl:text>Postscript: </xsl:text>
+        <xsl:value-of select="$doc"/>
+      </xsl:when>
+      <xsl:when test="string-length(substring-before($doc,'.pdf'))&gt;0"> <!--it's a PDF link-->
+        <xsl:text>PDF: </xsl:text>
+        <xsl:value-of select="$doc"/>
       </xsl:when>
       <xsl:otherwise>
@@ -121 +126 @@
 
     <xsl:value-of select="$dest"/>
-    <xsl:if test="substring-before($dest,'.ps')=''"> <!-- not postscript: add .hlp -->
-      <xsl:text>.hlp</xsl:text>
+    <xsl:if test="substring-before($dest,'.ps')=''"> <!-- not postscript .. -->
+      <xsl:if test="substring-before($dest,'.pdf')=''"> <!-- .. or pdf .. -->
+        <xsl:text>.hlp</xsl:text> <!-- .. -> add .hlp -->
+      </xsl:if>
     </xsl:if>
     <xsl:text>&br;</xsl:text>

trunk/HELP_SOURCE/to_html.xsl

@@ -37 +37 @@
     <xsl:value-of select="$rootpath"/><xsl:text>../help/</xsl:text>
   </xsl:variable>
+  <xsl:variable name="pdfpath"><xsl:value-of select="$postscriptpath"/></xsl:variable>
 
   <xsl:variable name="tableBorder">0</xsl:variable>
@@ -147 +148 @@
         <A href="{concat($postscriptpath,$doc,'.gz')}">
           <xsl:value-of select="$doc"/> (Postscript)
+        </A>
+      </xsl:when>
+      <xsl:when test="string-length(substring-before($doc,'.pdf'))&gt;0"> <!--it's a pdf link-->
+        <A href="{concat($pdfpath,$doc,'.gz')}">
+          <xsl:value-of select="$doc"/> (PDF)
         </A>
       </xsl:when>

trunk/WINDOW/AW_status.cxx

@@ -1519 +1519 @@
         if (!rel_path) rel_path = helpfile;
 
-        if (path_for_edit) {
+        if (rel_path[0]) {
+            if (path_for_edit) {
 #if defined(DEBUG)
-            char *gen_doc_path = GB_strdup(GB_path_in_ARBHOME("HELP_SOURCE/genhelp", NULL));
-
-            char *devel_source = GBS_global_string_copy("%s/%s", devel_doc_path, rel_path);
-            char *gen_source   = GBS_global_string_copy("%s/%s", gen_doc_path, rel_path);
-
-            int devel_size = GB_size_of_file(devel_source);
-            int gen_size   = GB_size_of_file(gen_source);
-
-            gb_assert(devel_size <= 0 || gen_size <= 0); // only one of them shall exist
-
-            if (gen_size>0) {
-                result = GBS_global_string("%s", gen_source); // edit generated doc
+                char *gen_doc_path = GB_strdup(GB_path_in_ARBHOME("HELP_SOURCE/genhelp", NULL));
+
+                char *devel_source = GBS_global_string_copy("%s/%s", devel_doc_path, rel_path);
+                char *gen_source   = GBS_global_string_copy("%s/%s", gen_doc_path, rel_path);
+
+                int devel_size = GB_size_of_file(devel_source);
+                int gen_size   = GB_size_of_file(gen_source);
+
+                gb_assert(devel_size <= 0 || gen_size <= 0); // only one of them shall exist
+
+                if (gen_size>0) {
+                    result = GBS_global_string("%s", gen_source); // edit generated doc
+                }
+                else {
+                    result = GBS_global_string("%s", devel_source); // use normal help source (may be non-existing)
+                }
+
+                free(gen_source);
+                free(devel_source);
+                free(gen_doc_path);
+#else            
+                result = GBS_global_string("%s/%s", GB_getenvDOCPATH(), rel_path); // use real help file in RELEASE
+#endif // DEBUG
             }
             else {
-                result = GBS_global_string("%s", devel_source); // use normal help source (may be non-existing)
-            }
-
-            free(gen_source);
-            free(devel_source);
-            free(gen_doc_path);
-#else            
-            result = GBS_global_string("%s/%s", GB_getenvDOCPATH(), rel_path); // use real help file in RELEASE
-#endif // DEBUG
+                result = GBS_global_string("%s/%s", GB_getenvDOCPATH(), rel_path);
+            }
         }
         else {
-            result = GBS_global_string("%s/%s", GB_getenvDOCPATH(), rel_path);
-        }
-    }
-
-#if defined(DEBUG)
-    printf("Helpfile='%s'\n", result);
-#endif // DEBUG
+            result = "";
+        }
+    }
 
     free(devel_doc_path);
@@ -1651 +1652 @@
 }
 
-static void aw_help_new_helpfile(AW_root *awr) {
+static void aw_help_select_newest_in_history(AW_root *aw_root) {
+    char *history = aw_help_global.history;
+    if (history) {
+        const char *sep      = strchr(history, '#');
+        char       *lastHelp = sep ? GB_strpartdup(history, sep-1) : strdup(history);
+
+        aw_root->awar("tmp/aw_window/helpfile")->write_string(lastHelp);
+        free(lastHelp);
+    }
+}
+
+static void aw_help_back(AW_root *aw_root) {
+    char *history = aw_help_global.history;
+    if (history) {
+        const char *sep = strchr(history, '#');
+        if (sep) {
+            char *first   = GB_strpartdup(history, sep-1);
+            char *newhist = GBS_global_string_copy("%s#%s", sep+1, first); // wrap first to end
+
+            free(aw_help_global.history);
+            aw_help_global.history = newhist;
+
+            free(first);
+            
+            aw_help_select_newest_in_history(aw_root);
+        }
+    }
+}
+static void aw_help_back(AW_window *aww) { aw_help_back(aww->get_root()); }
+
+static GB_ERROR aw_help_show_external_format(const char *help_file, const char *viewer) {
+    // Called to show *.ps or *.pdf in external viewer.
+    // Can as well show *.suffix.gz (decompresses to temporary *.suffix)
+    
+    struct stat st;
+    GB_ERROR    error = NULL;
+    char        sys[1024];
+
+    sys[0] = 0;
+
+    if (stat(help_file, &st) == 0) { // *.ps exists
+        GBS_global_string_to_buffer(sys, sizeof(sys), "%s %s &", viewer, help_file);
+    }
+    else {
+        char *compressed = GBS_global_string_copy("%s.gz", help_file);
+
+        if (stat(compressed, &st) == 0) { // *.ps.gz exists
+            char *name_ext;
+            GB_split_full_path(compressed, NULL, NULL, &name_ext, NULL);
+            // 'name_ext' contains xxx.ps or xxx.pdf
+            char *name, *suffix;
+            GB_split_full_path(name_ext, NULL, NULL, &name, &suffix);
+
+            char *tempname     = GB_unique_filename(name, suffix);
+            char *uncompressed = GB_create_tempfile(tempname);
+                
+            GBS_global_string_to_buffer(sys, sizeof(sys),
+                                        "(gunzip <%s >%s ; %s %s ; rm %s) &",
+                                        compressed, uncompressed,
+                                        viewer, uncompressed,
+                                        uncompressed);
+
+            free(uncompressed);
+            free(tempname);
+            free(name);
+            free(suffix);
+            free(name_ext);
+        }
+        else {
+            error = GBS_global_string("Neither %s nor %s exists", help_file, compressed);
+        }
+        free(compressed);
+    }
+
+    if (sys[0] && !error) error = GB_system(sys);
+
+    return error;
+}
+
+static void aw_help_helpfile_changed_cb(AW_root *awr) {
     char *help_file = get_full_qualified_help_file_name(awr);
 
@@ -1658 +1738 @@
     }
     else if (GBS_string_matches(help_file,"*.ps",GB_IGNORE_CASE) ){ // Postscript file
-        struct stat st;
-        GB_ERROR    error = 0;
-        char        sys[1024];
-        
-        sys[0] = 0;
-
-        if (stat(help_file, &st) == 0) { // *.ps exists
-            GBS_global_string_to_buffer(sys, sizeof(sys), "%s %s &", GB_getenvARB_GS(), help_file);
-        }
-        else {
-            char *compressed = GBS_global_string_copy("%s.gz", help_file);
-
-            if (stat(compressed, &st) == 0) { // *.ps.gz exists
-                char *name_ps;
-                GB_split_full_path(compressed, NULL, NULL, &name_ps, NULL);
-                // 'name_ps' contains xxx.ps
-                char *name, *suffix;
-                GB_split_full_path(name_ps, NULL, NULL, &name, &suffix);
-
-                char *tempname     = GB_unique_filename(name, suffix);
-                char *uncompressed = GB_create_tempfile(tempname);
-                
-                GBS_global_string_to_buffer(sys, sizeof(sys),
-                                            "(gunzip <%s >%s ; %s %s ; rm %s) &",
-                                            compressed, uncompressed,
-                                            GB_getenvARB_GS(), uncompressed,
-                                            uncompressed);
-
-                free(uncompressed);
-                free(tempname);
-                free(name);
-                free(suffix);
-                free(name_ps);
-            }
-            else {
-                sprintf(AW_ERROR_BUFFER, "Neither %s nor %s where found", help_file, compressed);
-                aw_message();
-            }
-            free(compressed);
-        }
-
-        if (sys[0] && !error) error = GB_system(sys);
+        GB_ERROR error = aw_help_show_external_format(help_file, GB_getenvARB_GS());
         if (error) aw_message(error);
+        aw_help_select_newest_in_history(awr);
+    }
+    else if (GBS_string_matches(help_file,"*.pdf",GB_IGNORE_CASE) ){ // PDF file
+        GB_ERROR error = aw_help_show_external_format(help_file, GB_getenvARB_PDFVIEW());
+        if (error) aw_message(error);
+        aw_help_select_newest_in_history(awr);
     }
     else{
         if (aw_help_global.history){
-            if (strncmp(help_file,aw_help_global.history,strlen(help_file))){
-                char comm[1024];
-                char *h;
-                sprintf(comm,"*=%s#*1",help_file);
-                h = GBS_string_eval(aw_help_global.history,comm,0);
+            if (strncmp(help_file,aw_help_global.history,strlen(help_file)) != 0) {
+                // remove current help from history (if present) and prefix it to history
+                char *comm = GBS_global_string_copy("*#%s*=*1*2:*=%s#*1", help_file, help_file);
+                char *h    = GBS_string_eval(aw_help_global.history,comm,0);
+
+                aw_assert(h);
+
                 free(aw_help_global.history);
                 aw_help_global.history = h;
+
+                free(comm);
             }
         }
@@ -1766 +1815 @@
     }
     free(help_file);
-}
-
-static void aw_help_back(AW_window *aww) {
-    if (!aw_help_global.history) return;
-    if (!strchr(aw_help_global.history,'#') ) return;
-    char *newhist = GBS_string_eval(aw_help_global.history,"*#*=*2",0); // delete first
-    free(aw_help_global.history);
-    aw_help_global.history = newhist;
-    char *helpfile = GBS_string_eval(aw_help_global.history,"*#*=*1",0);    // first word
-    aww->get_root()->awar("tmp/aw_window/helpfile")->write_string(helpfile);
-    free(helpfile);
 }
 
@@ -1888 +1926 @@
 }
 
-void AW_POPUP_HELP(AW_window *aw,AW_CL /*char */ helpcd)
-{
-    AW_root *awr=aw->get_root();
-    static AW_window_simple *helpwindow=0;
-
-
-    char *help_file= (char*)helpcd;
-
-
-    if(!helpwindow) {
+void AW_POPUP_HELP(AW_window *aw,AW_CL /*char */ helpcd) {
+    static AW_window_simple *helpwindow = 0;
+
+    AW_root *awr       = aw->get_root();
+    char    *help_file = (char*)helpcd;
+
+    if (!helpwindow) {
         awr->awar_string( "tmp/aw_window/helptext", "" , AW_ROOT_DEFAULT);
         awr->awar_string( "tmp/aw_window/search_expression", "" , AW_ROOT_DEFAULT);
         awr->awar_string( "tmp/aw_window/helpfile", "" , AW_ROOT_DEFAULT);
-        awr->awar("tmp/aw_window/helpfile")->add_callback(aw_help_new_helpfile);
-
-        helpwindow=new AW_window_simple;
+        awr->awar("tmp/aw_window/helpfile")->add_callback(aw_help_helpfile_changed_cb);
+
+        helpwindow = new AW_window_simple;
         helpwindow->init(awr,"HELP","HELP WINDOW");
         helpwindow->load_xfig("help.fig");
@@ -1949 +1984 @@
 
     }
-    free(aw_help_global.history);
-    aw_help_global.history = 0;
-
-    awr->awar("tmp/aw_window/helpfile")->write_string("");
-    if(help_file) awr->awar("tmp/aw_window/helpfile")->write_string(help_file);
-    if (GBS_string_matches(help_file,"*.ps",GB_IGNORE_CASE)) return;// dont open help if postscript file
-    helpwindow->show();
+
+    aw_assert(help_file);
+
+    awr->awar("tmp/aw_window/helpfile")->write_string(help_file);
+    
+    if (!GBS_string_matches(help_file,"*.ps",GB_IGNORE_CASE) &&
+        !GBS_string_matches(help_file,"*.pdf",GB_IGNORE_CASE))
+    { // dont open help if postscript or pdf file
+        helpwindow->show();
+    }
 }
 

trunk/WINDOW/aw_window.hxx

@@ -278 +278 @@
     // --------------------------------
     
-    AW_root *get_root(void) { return root; };
+    AW_root *get_root(void) { return root; }
 
     //******************* Global layout functions **********************