field type adjustments, ui fixes

Author: Lubos Kosco

src/org/opensolaris/opengrok/analysis/AnalyzerGuru.java

@@ -279,8 +279,8 @@ public void populateDocument(Document doc, File file, String path,
             }                   
             fa.analyze(doc, StreamSource.fromFile(file), xrefOut);
 
-            String fileType = fa.getFileTypeName();
-            doc.add(new StringField(QueryBuilder.FILETYPE, fileType, Store.YES));
+            String type = fa.getFileTypeName();
+            doc.add(new StringField(QueryBuilder.TYPE, type, Store.YES));
         }
     }
 

src/org/opensolaris/opengrok/search/QueryBuilder.java

@@ -49,7 +49,7 @@ public class QueryBuilder {
     public static final String REFS = "refs";
     public static final String PATH = "path";
     public static final String HIST = "hist";
-    public static final String FILETYPE = "fileType";
+    public static final String TYPE = "type";
     /**
      * Fields we use in lucene internal ones
      */
@@ -163,22 +163,22 @@ public String getHist() {
     }
 
     /**
-     * Set search string for the "fileType" field.
+     * Set search string for the "type" field.
      *
-     * @param fileType query string to set
+     * @param type query string to set
      * @return this instance
      */
-    public QueryBuilder setFileType(String fileType) {
-        return addQueryText(FILETYPE, fileType);
+    public QueryBuilder setType(String type) {
+        return addQueryText(TYPE, type);
     }
 
     /**
-     * Get search string for the "fileType" field.
+     * Get search string for the "type" field.
      *
      * @return {@code null} if not set, the query string otherwise.
      */
-    public String getFileType() {
-        return getQueryText(FILETYPE);
+    public String getType() {
+        return getQueryText(TYPE);
     }
 
     /**

src/org/opensolaris/opengrok/search/Search.java

@@ -43,7 +43,7 @@ final class Search {
             "\t -p Path\n" +
             "\t -h History\n" +
             "\t -f Full text\n" +
-            "\t -t File Type";
+            "\t -t Type";
 
     private SearchEngine engine;
     final List<Hit> results = new ArrayList<Hit>();
@@ -90,7 +90,7 @@ protected boolean parseCmdLine(String[] argv) {
                     engine.setFreetext(getopt.getOptarg());
                     break;
                 case 't':
-                    engine.setFileType(getopt.getOptarg());
+                    engine.setType(getopt.getOptarg());
                     break;
             }
         }

src/org/opensolaris/opengrok/search/SearchEngine.java

@@ -96,9 +96,9 @@ public class SearchEngine {
      */
     private String symbol;
     /**
-     * Holds value of property fileType
+     * Holds value of property type
      */
-    private String fileType;
+    private String type;
     /**
      * Holds value of property indexDatabase.
      */
@@ -141,7 +141,7 @@ private QueryBuilder createQueryBuilder() {
                 .setRefs(symbol)
                 .setPath(file)
                 .setHist(history)
-                .setFileType(fileType);
+                .setType(type);
     }
 
     public boolean isValidQuery() {
@@ -495,20 +495,20 @@ public void setSymbol(String symbol) {
     }
 
     /**
-     * Getter for property fileType.
+     * Getter for property type.
      *
-     * @return Value of property fileType.
+     * @return Value of property type.
      */
-    public String getFileType() {
-        return this.fileType;
+    public String getType() {
+        return this.type;
     }
 
     /**
-     * Setter for property fileType.
+     * Setter for property type.
      *
-     * @param fileType New value of property fileType.
+     * @param type New value of property type.
      */
-    public void setFileType(String fileType) {
-        this.fileType = fileType;
+    public void setType(String fileType) {
+        this.type = fileType;
     }
 }

src/org/opensolaris/opengrok/web/PageConfig.java

@@ -466,7 +466,7 @@ public QueryBuilder getQueryBuilder() {
                     .setRefs(req.getParameter("refs"))
                     .setPath(req.getParameter("path"))
                     .setHist(req.getParameter("hist"))
-                    .setFileType(req.getParameter("type"));
+                    .setType(req.getParameter("type"));
 
             // This is for backward compatibility with links created by OpenGrok
             // 0.8.x and earlier. We used to concatenate the entire query into a

web/default/style.css

@@ -45,7 +45,7 @@ tbody tr:nth-child(EVEN) { /* alternate color for odd rows */
 }
 
 input, button {
-	border: 1px #bbbbff #755;
+	border: 1px solid #bbbbff;
 	border-radius: 0.75ex;
 	-moz-border-radius: 0.75ex;
 	background-color: #a3b8cb;
@@ -465,7 +465,7 @@ table#dirlist { /* the "Name" column */
 	display: inline-block;
 	width: 6ex;
 	text-align: right;
-	padding-right: 0 1ex;
+	padding-right: 0;
 	margin-right: .5ex;
 	background-color: #dddddd;
 	color: #666;

web/help.jsp

@@ -53,6 +53,44 @@ include file="menu.jspf"
         </div>
         <div id="help">
 <p>
+
+<dfn><b>Examples:</b></dfn>
+<pre class="example">
+
+To find where setResourceMonitors is defined: 
+<a href="search?q=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
+
+To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
+<a href="search?refs=sprintf&amp;path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F"
+>refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
+
+To find assignments to variable foo:
+<a href="search?q=%22foo+%3D%22">"foo ="</a>
+
+To find Makefiles where pstack binary is being built:
+<a href="search?q=pstack&amp;path=Makefile">pstack path:Makefile</a>
+
+to search for phrase "Bill Joy":
+<a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
+
+To find perl files that do not use /usr/bin/perl but something else:
+<a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22"
+>-"/usr/bin/perl" +"/bin/perl"</a>
+
+To find all strings begining with foo use the wildcard:
+<a href="search?q=foo*">foo*</a>
+
+To find all files which have . c in their name(dot is a token!):
+<a href="search?path=%22. c%22">". c"</a>
+
+To find all files which start with "ma" and then have only alphabet characters do:
+<a href="search?path=/ma[a-zA-Z]*/">path:/ma[a-zA-Z]*/</a>
+
+To find all main methods in all files analyzed by C analyzer (so .c, .h, ...) do:
+<a href="search?q=main&type=c">main type:c</a>
+</pre>
+<br/>
+<dfn><b>More info:</b></dfn><br/><br/>
 A <dfn>Query</dfn> is a series of clauses. A clause may be prefixed by:</p>
 <ul>
     <li>a plus "<b>+</b>" or a minus "<b>-</b>" sign, indicating that the clause
@@ -81,7 +119,7 @@ A <dfn>Query</dfn> is a series of clauses. A clause may be prefixed by:</p>
         e.g.  /[mb]an/ - will search for man or for ban;<br>
         NOTE: path field search escapes "/" by default, so it only supports 
         regexps when the search string <u>starts and ends</u> with "/".<br>
-        More info can be found on <a href="http://lucene.apache.org/core/4_3_0/core/org/apache/lucene/util/automaton/RegExp.html?is-external=true">lucene regexp page</a>.
+        More info can be found on <a href="http://lucene.apache.org/core/4_3_1/core/org/apache/lucene/util/automaton/RegExp.html?is-external=true">lucene regexp page</a>.
     </li>
     <li>to perform a single character wildcard search use the "<b>?</b>" symbol,
         e.g.  te?t</li>
@@ -129,59 +167,29 @@ So searching for <b>\+1</b> or <b>\+ 1</b> will both find <b>+1</b> and <b>+ 1</
 <dd>Search through all text tokens(words,strings,identifiers,numbers) in index.</dd>
 
 <dt>defs</dt>
-<dd>Only finds symbol definitions.</dd>
+<dd>Only finds symbol definitions(where e.g. a variable(function, ...) is defined).</dd>
 
 <dt>refs</dt>
-<dd>Only finds symbols.</dd>
+<dd>Only finds symbols(e.g. methods, classes, functions, variables).</dd>
 
 <dt>path</dt>
-<dd>path of the source file.</dd>
+<dd>path of the source file(no need to use dividers).</dd>
 
 <dt>hist</dt>
 <dd>History log comments.</dd>
+
+<dt>type</dt>
+<dd>Type of analyzer used to scope down to certain file types(e.g. just C sources).<br/>Current mappings: <%=SearchHelper.getFileTypeDescirptions().toString()%></dd>
+
     </dl>
 
 <p>
 the term(phrases) can be boosted (making it more relevant) using a caret
 <b>^</b> , e.g. help^4 opengrok - will make term help boosted
 </p>
 
-<dfn><b>Examples:</b></dfn>
-<pre class="example">
-
-To find where setResourceMonitors is defined: 
-<a href="search?q=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
-
-To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
-<a href="search?refs=sprintf&amp;path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F"
->refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
-
-To find assignments to variable foo:
-<a href="search?q=%22foo+%3D%22">"foo ="</a>
-
-To find Makefiles where pstack binary is being built:
-<a href="search?q=pstack&amp;path=Makefile">pstack path:Makefile</a>
-
-to search for phrase "Bill Joy":
-<a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
-
-To find perl files that do not use /usr/bin/perl but something else:
-<a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22"
->-"/usr/bin/perl" +"/bin/perl"</a>
-
-To find all strings begining with foo use the wildcard:
-<a href="search?q=foo*">sefoo*</a>
-
-To find all files which have . c in their name(dot is a token!):
-<a href="search?path=%22. c%22">". c"</a>
-
-To find all files which start with "ma" and then have only alphabet characters do:
-<a href="search?path=/ma[a-zA-Z]*/">/ma[a-zA-Z]*/</a>
-
-</pre>
-
 <p>Opengrok search is powered by <a href="http://lucene.apache.org/"
->lucene</a>, for more detail on query syntax refer to <a href="http://lucene.apache.org/core/4_3_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">lucene docs</a>.<br>
+>lucene</a>, for more detail on query syntax refer to <a href="http://lucene.apache.org/core/4_3_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">lucene docs</a>.<br>
 </p>
         </div>
 <%

web/httpheader.jspf

@@ -55,7 +55,7 @@ include file="pageconfig.jspf"
 <head>
 <meta name="robots" content="noindex,nofollow" />
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="<%=Info.getVersion()%> (<%=Info.getRevision()%>)" />
+<meta name="generator" content="{OpenGrok <%=Info.getVersion()%> (<%=Info.getRevision()%>)" />
 <meta http-equiv="X-UA-Compatible" content="IE=8" />
 <link rel="icon" href="<%=styleDir%>/img/icon.png" type="image/png" />
 <link rel="stylesheet" type="text/css" media="all"

web/menu.jspf

@@ -78,34 +78,34 @@ org.opensolaris.opengrok.web.Util"
 <div id="qtbl">
 <table>
     <tr>
-        <td><label for="s1">Full&nbsp;Search</label></td>
+        <td><label for="s1" title="The text token(s) or other fields to be found(lucene query, this is not full text!)">Full&nbsp;Search</label></td>
         <td><input tabindex="1" class="q" name="q" id="q" value="<%=
                 Util.formQuoteEscape(queryParams.getFreetext()) %>"/></td>
     </tr>
     <tr>
-        <td><label for="s2">Definition</label></td>
+	    <td><label for="s2" title="Definition of function/variable/class">Definition</label></td>
         <td><input class="q" tabindex="2" name="defs" id="defs" value="<%=
             Util.formQuoteEscape(queryParams.getDefs()) %>"/></td>
     </tr>
     <tr>
-        <td><label for="s3">Symbol</label></td>
+        <td><label for="s3" title="Usage of function/variable/class">Symbol</label></td>
         <td><input class="q" tabindex="3" name="refs" id="refs" value="<%=
             Util.formQuoteEscape(queryParams.getRefs()) %>"/></td>
     </tr>
     <tr>
-        <td><label for="s4">File&nbsp;Path</label></td>
+        <td><label for="s4" title="path or parts of it, no need to use dividers">File&nbsp;Path</label></td>
         <td><input class="q" tabindex="4" name="path" id="path" value="<%=
             Util.formQuoteEscape(queryParams.getPath()) %>"/></td>
     </tr>
     <tr>
-        <td><label for="s5">History</label></td>
+        <td><label for="s5" title="Search in log messages">History</label></td>
         <td><input class="q" tabindex="5" name="hist" id="hist" value="<%=
             Util.formQuoteEscape(queryParams.getHist()) %>"/></td>
     </tr>
     <tr>
         <td><label for="s5">Type</label></td>
         <td><select class="q" tabindex="6" name="type" id="type"><%
-                String selection = queryParams.getFileType();  
+                String selection = queryParams.getType();  
                 %>
                 <option value="">Any</option><%
                 for (Map.Entry<String, String> d : SearchHelper.getFileTypeDescirptions()) {
@@ -186,12 +186,12 @@ org.opensolaris.opengrok.web.Util"
     }
     %>
 
-<p><input
-    tabindex="9" class="submit" type="submit" value="Search"/> <input
-    tabindex="10" class="submit" onclick="javascript: clearSearchFrom();" type="button"
-    value=" Clear "/> <button class="help"
-    tabindex="11" onclick="window.open('help.jsp')">Help</button>
-</p>
+    <p><input tabindex="9" class="submit" type="submit" value="Search"/> 
+    <input tabindex="10" class="submit" onclick="javascript: clearSearchFrom();" 
+	   type="button" value=" Clear "/> 
+    <button class="help" tabindex="11" onclick="window.open('help.jsp');">Help
+    </button>
+    </p>
 </form>
 <%
 }

web/polished/style.css

@@ -46,7 +46,7 @@ tbody tr:nth-child(EVEN) { /* alternate color for odd rows */
 }
 
 input, button {
-	border: 1px solid #bbb #755;
+	border: 1px solid #bbb;
 	border-radius: 0.75ex;
 	-moz-border-radius: 0.75ex;
 	background-image: -webkit-gradient(