]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/qt_helpers.cpp
Make a string translatable
[lyx.git] / src / frontends / qt4 / qt_helpers.cpp
index 2c14d42149a32545d8bb9302fda74bb5d6603b95..f7ec99b13169432163956b37b3e4402031e27710 100644 (file)
@@ -4,7 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Dekel Tsur
- * \author Jürgen Spitzmüller
+ * \author Jürgen Spitzmüller
  * \author Richard Heck
  *
  * Full author contact details are available in file CREDITS.
 
 #include <config.h>
 
-#include "LengthCombo.h"
 #include "qt_helpers.h"
 
-#include "lengthcommon.h"
-#include "gettext.h"
+#include "FileDialog.h"
+#include "LengthCombo.h"
 
-#include "support/os.h"
-#include "support/lstrings.h"
+#include "frontends/alert.h"
 
-#include "debug.h"
+#include "BufferParams.h"
+#include "FloatList.h"
+#include "Language.h"
+#include "Length.h"
+#include "TextClass.h"
 
-#include <QComboBox>
+#include "support/convert.h"
+#include "support/debug.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+#include "support/lyxalgo.h"
+#include "support/os.h"
+#include "support/Package.h"
+#include "support/PathChanger.h"
+#include "support/Systemcall.h"
+
+#include <QApplication>
 #include <QCheckBox>
-#include <qlineedit.h>
-#include <qtextcodec.h>
+#include <QComboBox>
+#include <QLineEdit>
+#include <QLocale>
+#include <QPalette>
+#include <QSet>
+#include <QTextLayout>
+#include <QTextDocument>
+#include <QToolTip>
 
 #include <algorithm>
+#include <fstream>
+#include <locale>
 
+// for FileFilter.
+// FIXME: Remove
+#include "support/regex.h"
 
-namespace lyx {
 
-using support::isStrDbl;
+using namespace std;
+using namespace lyx::support;
 
-using std::vector;
-using std::make_pair;
-using std::string;
-using std::pair;
-using std::endl;
+namespace lyx {
+
+FileName libFileSearch(QString const & dir, QString const & name,
+                               QString const & ext, search_mode mode)
+{
+       return support::libFileSearch(fromqstr(dir), fromqstr(name), fromqstr(ext), mode);
+}
 
 
-string makeFontName(string const & family, string const & foundry)
+FileName imageLibFileSearch(QString & dir, QString const & name,
+                               QString const & ext, search_mode mode)
 {
-       if (foundry.empty())
-               return family;
-       return family + " [" + foundry + ']';
+       string tmp = fromqstr(dir);
+       FileName fn = support::imageLibFileSearch(tmp, fromqstr(name), fromqstr(ext), mode);
+       dir = toqstr(tmp);
+       return fn;
 }
 
+namespace {
 
-pair<string, string> parseFontName(string const & name)
+double locstringToDouble(QString const & str)
 {
-       string::size_type const idx = name.find('[');
-       if (idx == string::npos || idx == 0)
-               return make_pair(name, string());
-       return make_pair(name.substr(0, idx - 1),
-                        name.substr(idx + 1, name.size() - idx - 2));
+       QLocale loc;
+       bool ok;
+       double res = loc.toDouble(str, &ok);
+       if (!ok) {
+               // Fall back to C
+               QLocale c(QLocale::C);
+               res = c.toDouble(str);
+       }
+       return res;
 }
 
+} // namespace anon
+
+
+namespace frontend {
 
 string widgetsToLength(QLineEdit const * input, LengthCombo const * combo)
 {
@@ -72,7 +108,7 @@ string widgetsToLength(QLineEdit const * input, LengthCombo const * combo)
 
        Length::UNIT const unit = combo->currentLengthItem();
 
-       return Length(length.toDouble(), unit).asString();
+       return Length(locstringToDouble(length.trimmed()), unit).asString();
 }
 
 
@@ -86,17 +122,32 @@ Length widgetsToLength(QLineEdit const * input, QComboBox const * combo)
        if (isValidGlueLength(fromqstr(length)))
                return Length(fromqstr(length));
 
-       Length::UNIT const unit = unitFromString(fromqstr(combo->currentText()));
+       Length::UNIT unit = Length::UNIT_NONE;
+       QString const item = combo->currentText();
+       for (int i = 0; i < num_units; i++) {
+               if (qt_(lyx::unit_name_gui[i]) == item) {
+                       unit = unitFromString(unit_name[i]);
+                       break;
+               }
+       }
 
-       return Length(length.toDouble(), unit);
+       return Length(locstringToDouble(length.trimmed()), unit);
 }
 
 
 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
-                     Length const & len, Length::UNIT /*defaultUnit*/)
+       Length const & len, Length::UNIT /*defaultUnit*/)
 {
-       combo->setCurrentItem(Length(len).unit());
-       input->setText(QString::number(Length(len).value()));
+       if (len.empty()) {
+               // no length (UNIT_NONE)
+               combo->setCurrentItem(Length::defaultUnit());
+               input->setText("");
+       } else {
+               combo->setCurrentItem(len.unit());
+               QLocale loc;
+               loc.setNumberOptions(QLocale::OmitGroupSeparator);
+               input->setText(formatLocFPNumber(Length(len).value()));
+       }
 }
 
 
@@ -117,29 +168,108 @@ void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
 }
 
 
-void lengthAutoToWidgets(QLineEdit * input, LengthCombo * combo,
-       Length const & len, Length::UNIT defaultUnit)
+void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
+       docstring const & len, Length::UNIT defaultUnit)
+{
+       lengthToWidgets(input, combo, to_utf8(len), defaultUnit);
+}
+
+
+double widgetToDouble(QLineEdit const * input)
+{
+       QString const text = input->text();
+       if (text.isEmpty())
+               return 0.0;
+
+       return locstringToDouble(text.trimmed());
+}
+
+
+string widgetToDoubleStr(QLineEdit const * input)
+{
+       return convert<string>(widgetToDouble(input));
+}
+
+
+void doubleToWidget(QLineEdit * input, double const & value, char f, int prec)
+{
+       QLocale loc;
+       loc.setNumberOptions(QLocale::OmitGroupSeparator);
+       input->setText(loc.toString(value, f, prec));
+}
+
+
+void doubleToWidget(QLineEdit * input, string const & value, char f, int prec)
+{
+       doubleToWidget(input, convert<double>(value), f, prec);
+}
+
+
+QString formatLocFPNumber(double d)
+{
+       QString result = toqstr(formatFPNumber(d));
+       QLocale loc;
+       result.replace('.', loc.decimalPoint());
+       return result;
+}
+
+
+bool ColorSorter(ColorCode lhs, ColorCode rhs)
+{
+       return compare_no_case(lcolor.getGUIName(lhs), lcolor.getGUIName(rhs)) < 0;
+}
+
+
+void setValid(QWidget * widget, bool valid)
+{
+       if (valid) {
+               widget->setPalette(QPalette());
+       } else {
+               QPalette pal = widget->palette();
+               pal.setColor(QPalette::Active, QPalette::Foreground, QColor(255, 0, 0));
+               widget->setPalette(pal);
+       }
+}
+
+
+void focusAndHighlight(QAbstractItemView * w)
 {
-       if (len.value() == 0)
-               lengthToWidgets(input, combo, "auto", defaultUnit);
-       else
-               lengthToWidgets(input, combo, len, defaultUnit);
+       w->setFocus();
+       w->setCurrentIndex(w->currentIndex());
+       w->scrollTo(w->currentIndex());
 }
 
 
-//NOTE "CB" here because we probably will want one of these
-//for labeled sets, as well.
-void setAutoTextCB(QCheckBox * checkBox, QLineEdit * lineEdit,
-       LengthCombo * lengthCombo)
+void setMessageColour(list<QWidget *> highlighted, list<QWidget *> plain)
 {
-       if (!checkBox->isChecked())
-               lengthToWidgets(lineEdit, lengthCombo,
-                               "auto", lengthCombo->currentLengthItem());
-       else if (lineEdit->text() == "auto")
-               lengthToWidgets(lineEdit, lengthCombo, string(),
-                               lengthCombo->currentLengthItem());
+       QPalette pal = QApplication::palette();
+       QPalette newpal(pal.color(QPalette::Active, QPalette::HighlightedText),
+                       pal.color(QPalette::Active, QPalette::Highlight));
+       for (QWidget * w : highlighted)
+               w->setPalette(newpal);
+       for (QWidget * w : plain)
+               w->setPalette(pal);
+}
+
+
+/// wrapper to hide the change of method name to setSectionResizeMode
+void setSectionResizeMode(QHeaderView * view,
+    int logicalIndex, QHeaderView::ResizeMode mode) {
+#if (QT_VERSION >= 0x050000)
+       view->setSectionResizeMode(logicalIndex, mode);
+#else
+       view->setResizeMode(logicalIndex, mode);
+#endif
 }
 
+void setSectionResizeMode(QHeaderView * view, QHeaderView::ResizeMode mode) {
+#if (QT_VERSION >= 0x050000)
+       view->setSectionResizeMode(mode);
+#else
+       view->setResizeMode(mode);
+#endif
+}
+} // namespace frontend
 
 QString const qt_(char const * str, const char *)
 {
@@ -153,62 +283,380 @@ QString const qt_(string const & str)
 }
 
 
-docstring const formatted(docstring const & text, int w)
+QString const qt_(QString const & qstr)
 {
-       docstring sout;
+       return toqstr(_(fromqstr(qstr)));
+}
 
-       if (text.empty())
-               return sout;
 
-       docstring::size_type curpos = 0;
-       docstring line;
+void rescanTexStyles(string const & arg)
+{
+       // Run rescan in user lyx directory
+       PathChanger p(package().user_support());
+       FileName const prog = support::libFileSearch("scripts", "TeXFiles.py");
+       Systemcall one;
+       string const command = os::python() + ' ' +
+           quoteName(prog.toFilesystemEncoding()) + ' ' +
+           arg;
+       int const status = one.startscript(Systemcall::Wait, command);
+       if (status == 0)
+               return;
+       // FIXME UNICODE
+       frontend::Alert::error(_("Could not update TeX information"),
+               bformat(_("The script `%1$s' failed."), from_utf8(prog.absFileName())));
+}
 
-       for (;;) {
-               docstring::size_type const nxtpos1 = text.find(' ',  curpos);
-               docstring::size_type const nxtpos2 = text.find('\n', curpos);
-               docstring::size_type const nxtpos = std::min(nxtpos1, nxtpos2);
 
-               docstring const word =
-                       nxtpos == docstring::npos ?
-                       text.substr(curpos) :
-                       text.substr(curpos, nxtpos - curpos);
+QStringList texFileList(QString const & filename)
+{
+       QStringList list;
+       FileName const file = libFileSearch(QString(), filename);
+       if (file.empty())
+               return list;
+
+       // FIXME Unicode.
+       vector<docstring> doclist = 
+               getVectorFromString(file.fileContents("UTF-8"), from_ascii("\n"));
+
+       // Normalise paths like /foo//bar ==> /foo/bar
+       QSet<QString> set;
+       for (size_t i = 0; i != doclist.size(); ++i) {
+               QString file = toqstr(doclist[i]);
+               file.replace("\r", "");
+               while (file.contains("//"))
+                       file.replace("//", "/");
+               if (!file.isEmpty())
+                       set.insert(file);
+       }
+
+       // remove duplicates
+       return QList<QString>::fromSet(set);
+}
 
-               bool const newline = (nxtpos2 != docstring::npos &&
-                                     nxtpos2 < nxtpos1);
+QString const externalLineEnding(docstring const & str)
+{
+#ifdef Q_OS_MAC
+       // The MAC clipboard uses \r for lineendings, and we use \n
+       return toqstr(subst(str, '\n', '\r'));
+#elif defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)
+       // Windows clipboard uses \r\n for lineendings, and we use \n
+       return toqstr(subst(str, from_ascii("\n"), from_ascii("\r\n")));
+#else
+       return toqstr(str);
+#endif
+}
 
-               docstring const line_plus_word =
-                       line.empty() ? word : line + char_type(' ') + word;
 
-               // FIXME: make w be size_t
-               if (int(line_plus_word.length()) >= w) {
-                       sout += line + char_type('\n');
-                       if (newline) {
-                               sout += word + char_type('\n');
-                               line.erase();
-                       } else {
-                               line = word;
-                       }
+docstring const internalLineEnding(QString const & str)
+{
+       docstring const s = subst(qstring_to_ucs4(str), 
+                                 from_ascii("\r\n"), from_ascii("\n"));
+       return subst(s, '\r', '\n');
+}
+
+
+QString internalPath(const QString & str)
+{
+       return toqstr(os::internal_path(fromqstr(str)));
+}
+
+
+QString onlyFileName(const QString & str)
+{
+       return toqstr(support::onlyFileName(fromqstr(str)));
+}
 
-               } else if (newline) {
-                       sout += line_plus_word + char_type('\n');
-                       line.erase();
 
-               } else {
-                       if (!line.empty())
-                               line += char_type(' ');
-                       line += word;
+QString onlyPath(const QString & str)
+{
+       return toqstr(support::onlyPath(fromqstr(str)));
+}
+
+
+QString changeExtension(QString const & oldname, QString const & ext)
+{
+       return toqstr(support::changeExtension(fromqstr(oldname), fromqstr(ext)));
+}
+
+/// Remove the extension from \p name
+QString removeExtension(QString const & name)
+{
+       return toqstr(support::removeExtension(fromqstr(name)));
+}
+
+/** Add the extension \p ext to \p name.
+ Use this instead of changeExtension if you know that \p name is without
+ extension, because changeExtension would wrongly interpret \p name if it
+ contains a dot.
+ */
+QString addExtension(QString const & name, QString const & ext)
+{
+       return toqstr(support::addExtension(fromqstr(name), fromqstr(ext)));
+}
+
+/// Return the extension of the file (not including the .)
+QString getExtension(QString const & name)
+{
+       return toqstr(support::getExtension(fromqstr(name)));
+}
+
+
+/** Convert relative path into absolute path based on a basepath.
+  If relpath is absolute, just use that.
+  If basepath doesn't exist use CWD.
+  */
+QString makeAbsPath(QString const & relpath, QString const & base)
+{
+       return toqstr(support::makeAbsPath(fromqstr(relpath),
+               fromqstr(base)).absFileName());
+}
+
+
+/////////////////////////////////////////////////////////////////////////
+//
+// FileFilterList
+//
+/////////////////////////////////////////////////////////////////////////
+
+/** Given a string such as
+ *      "<glob> <glob> ... *.{abc,def} <glob>",
+ *  convert the csh-style brace expresions:
+ *      "<glob> <glob> ... *.abc *.def <glob>".
+ *  Requires no system support, so should work equally on Unix, Mac, Win32.
+ */
+static string const convert_brace_glob(string const & glob)
+{
+       // Matches " *.{abc,def,ghi}", storing "*." as group 1 and
+       // "abc,def,ghi" as group 2, while allowing spaces in group 2.
+       static lyx::regex const glob_re(" *([^ {]*)\\{([^}]+)\\}");
+       // Matches "abc" and "abc,", storing "abc" as group 1,
+       // while ignoring surrounding spaces.
+       static lyx::regex const block_re(" *([^ ,}]+) *,? *");
+
+       string pattern;
+
+       string::const_iterator it = glob.begin();
+       string::const_iterator const end = glob.end();
+       while (true) {
+               match_results<string::const_iterator> what;
+               if (!regex_search(it, end, what, glob_re)) {
+                       // Ensure that no information is lost.
+                       pattern += string(it, end);
+                       break;
                }
 
-               if (nxtpos == docstring::npos) {
-                       if (!line.empty())
-                               sout += line;
+               // Everything from the start of the input to
+               // the start of the match.
+               pattern += string(what[-1].first, what[-1].second);
+
+               // Given " *.{abc,def}", head == "*." and tail == "abc,def".
+               string const head = string(what[1].first, what[1].second);
+               string const tail = string(what[2].first, what[2].second);
+
+               // Split the ','-separated chunks of tail so that
+               // $head{$chunk1,$chunk2} becomes "$head$chunk1 $head$chunk2".
+               string const fmt = " " + head + "$1";
+               pattern += regex_replace(tail, block_re, fmt);
+
+               // Increment the iterator to the end of the match.
+               it += distance(it, what[0].second);
+       }
+
+       return pattern;
+}
+
+
+struct Filter
+{
+       /* \param description text describing the filters.
+        * \param one or more wildcard patterns, separated by
+        * whitespace.
+        */
+       Filter(docstring const & description, std::string const & globs);
+
+       docstring const & description() const { return desc_; }
+
+       QString toString() const;
+
+       docstring desc_;
+       std::vector<std::string> globs_;
+};
+
+
+Filter::Filter(docstring const & description, string const & globs)
+       : desc_(description)
+{
+       // Given "<glob> <glob> ... *.{abc,def} <glob>", expand to
+       //       "<glob> <glob> ... *.abc *.def <glob>"
+       string const expanded_globs = convert_brace_glob(globs);
+
+       // Split into individual globs.
+       globs_ = getVectorFromString(expanded_globs, " ");
+}
+
+
+QString Filter::toString() const
+{
+       QString s;
+
+       bool const has_description = !desc_.empty();
+
+       if (has_description) {
+               s += toqstr(desc_);
+               s += " (";
+       }
+
+       s += toqstr(getStringFromVector(globs_, " "));
+
+       if (has_description)
+               s += ')';
+       return s;
+}
+
+
+/** \c FileFilterList parses a Qt-style list of available file filters
+ *  to generate the corresponding vector.
+ *  For example "TeX documents (*.tex);;LyX Documents (*.lyx)"
+ *  will be parsed to fill a vector of size 2, whilst "*.{p[bgp]m} *.pdf"
+ *  will result in a vector of size 1 in which the description field is empty.
+ */
+struct FileFilterList
+{
+       // FIXME UNICODE: globs_ should be unicode...
+       /** \param qt_style_filter a list of available file filters.
+        *  Eg. "TeX documents (*.tex);;LyX Documents (*.lyx)".
+        *  The "All files (*)" filter is always added to the list.
+        */
+       explicit FileFilterList(docstring const & qt_style_filter =
+                               docstring());
+
+       typedef std::vector<Filter>::size_type size_type;
+
+       bool empty() const { return filters_.empty(); }
+       size_type size() const { return filters_.size(); }
+       Filter & operator[](size_type i) { return filters_[i]; }
+       Filter const & operator[](size_type i) const { return filters_[i]; }
+
+       void parse_filter(std::string const & filter);
+       std::vector<Filter> filters_;
+};
+
+
+FileFilterList::FileFilterList(docstring const & qt_style_filter)
+{
+       // FIXME UNICODE
+       string const filter = to_utf8(qt_style_filter)
+               + (qt_style_filter.empty() ? string() : ";;")
+               + to_utf8(_("All Files "))
+#if defined(_WIN32)            
+               + ("(*.*)");
+#else
+               + ("(*)");
+#endif
+
+       // Split data such as "TeX documents (*.tex);;LyX Documents (*.lyx)"
+       // into individual filters.
+       static lyx::regex const separator_re(";;");
+
+       string::const_iterator it = filter.begin();
+       string::const_iterator const end = filter.end();
+       while (true) {
+               match_results<string::const_iterator> what;
+
+               if (!lyx::regex_search(it, end, what, separator_re)) {
+                       parse_filter(string(it, end));
                        break;
                }
 
-               curpos = nxtpos + 1;
+               // Everything from the start of the input to
+               // the start of the match.
+               parse_filter(string(it, what[0].first));
+
+               // Increment the iterator to the end of the match.
+               it += distance(it, what[0].second);
        }
+}
+
+
+void FileFilterList::parse_filter(string const & filter)
+{
+       // Matches "TeX documents (plain) (*.tex)",
+       // storing "TeX documents (plain) " as group 1 and "*.tex" as group 2.
+       static lyx::regex const filter_re("(.*)\\(([^()]+)\\) *$");
+
+       match_results<string::const_iterator> what;
+       if (!lyx::regex_search(filter, what, filter_re)) {
+               // Just a glob, no description.
+               filters_.push_back(Filter(docstring(), trim(filter)));
+       } else {
+               // FIXME UNICODE
+               docstring const desc = from_utf8(string(what[1].first, what[1].second));
+               string const globs = string(what[2].first, what[2].second);
+               filters_.push_back(Filter(trim(desc), trim(globs)));
+       }
+}
+
+
+/** \returns the equivalent of the string passed in
+ *  although any brace expressions are expanded.
+ *  (E.g. "*.{png,jpg}" -> "*.png *.jpg")
+ */
+QStringList fileFilters(QString const & desc)
+{
+       // we have: "*.{gif,png,jpg,bmp,pbm,ppm,tga,tif,xpm,xbm}"
+       // but need:  "*.cpp;*.cc;*.C;*.cxx;*.c++"
+       FileFilterList filters(qstring_to_ucs4(desc));
+       //LYXERR0("DESC: " << desc);
+       QStringList list;
+       for (size_t i = 0; i != filters.filters_.size(); ++i) {
+               QString f = filters.filters_[i].toString();
+               //LYXERR0("FILTER: " << f);
+               list.append(f);
+       }
+       return list;
+}
+
+
+QString formatToolTip(QString text, int em)
+{
+       // 1. QTooltip activates word wrapping only if mightBeRichText()
+       //    is true. So we convert the text to rich text.
+       //
+       // 2. The default width is way too small. Setting the width is tricky; first
+       //    one has to compute the ideal width, and then force it with special
+       //    html markup.
+
+       // do nothing if empty or already formatted
+       if (text.isEmpty() || text.startsWith(QString("<html>")))
+               return text;
+       // Convert to rich text if it is not already
+       if (!Qt::mightBeRichText(text))
+               text = Qt::convertFromPlainText(text, Qt::WhiteSpaceNormal);
+       // Compute desired width in pixels
+       QFont const font = QToolTip::font();
+       int const px_width = em * QFontMetrics(font).width("M");
+       // Determine the ideal width of the tooltip
+       QTextDocument td("");
+       td.setHtml(text);
+       td.setDefaultFont(QToolTip::font());
+       td.setTextWidth(px_width);
+       double best_width = td.idealWidth();
+       // Set the line wrapping with appropriate width
+       return QString("<html><body><table><tr>"
+                      "<td align=justify width=%1>%2</td>"
+                      "</tr></table></body></html>")
+               .arg(QString::number(int(best_width) + 1), text);
+}
+
 
-       return sout;
+QString qtHtmlToPlainText(QString const & html)
+{
+       if (!Qt::mightBeRichText(html))
+               return html;
+       QTextDocument td;
+       td.setHtml(html);
+       return td.toPlainText();
 }
 
+
 } // namespace lyx