-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 2000-2001 The LyX Team.
+/**
+ * \file FormCitation.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ======================================================
+ * \author Angus Leeming
+ * \author Rob Lahaye
*
- * \file FormCitation.C
- * \author Angus Leeming, a.leeming@ic.ac.uk
+ * Full author contact details are available in file CREDITS
*/
#include <config.h>
#include <algorithm>
-#ifdef __GNUG__
-#pragma implementation
-#endif
#include "xformsBC.h"
#include "ControlCitation.h"
#include "FormCitation.h"
-#include "form_citation.h"
-#include "gettext.h"
-#include "support/lstrings.h"
-#include "biblio.h"
+#include "forms/form_citation.h"
+#include "Kernel.h"
+#include "Tooltips.h"
#include "helper_funcs.h"
#include "xforms_helpers.h"
+#include FORMS_H_LOCATION
+
+#include "gettext.h"
+#include "support/LAssert.h"
+#include "support/lstrings.h"
using std::find;
using std::max;
using std::sort;
using std::vector;
-typedef FormCB<ControlCitation, FormDB<FD_form_citation> > base_class;
+namespace {
+
+// shamelessly stolen from Menubar_pimpl.C
+int string_width(string const & str)
+{
+ return fl_get_string_widthTAB(FL_NORMAL_STYLE, FL_NORMAL_SIZE,
+ str.c_str(),
+ static_cast<int>(str.length()));
+}
+
+
+void fillChoice(FD_citation * dialog, vector<string> vec)
+{
+ // Check whether the current contents of the browser will be
+ // changed by loading the contents of the vec...
+ vector<string> const choice_style = getVector(dialog->choice_style);
+
+ if (vec == choice_style)
+ return;
+
+ // They will be changed. Proceed
+ bool const noVec = vec.empty();
+ string const str = noVec ? string() : getStringFromVector(vec, "|");
+
+ fl_clear_choice(dialog->choice_style);
+ fl_addto_choice(dialog->choice_style, str.c_str());
+ setEnabled(dialog->choice_style, !noVec);
+}
+
+
+void updateStyle(FD_citation * dialog, string command)
+{
+ // Find the style of the citekeys
+ vector<biblio::CiteStyle> const & styles =
+ ControlCitation::getCiteStyles();
+ biblio::CitationStyle cs = biblio::getCitationStyle(command);
+
+ vector<biblio::CiteStyle>::const_iterator cit =
+ find(styles.begin(), styles.end(), cs.style);
+
+ // Use this to initialise the GUI
+ bool const noStyles = cit == styles.end();
+ int const index = 1 + ( noStyles ? 0 : int(cit - styles.begin()) );
+ fl_set_choice(dialog->choice_style, index);
+
+ // Disable if there are no styles, otherwise use cs member settings.
+ fl_set_button(dialog->check_full_author_list, !noStyles && cs.full);
+ fl_set_button(dialog->check_force_uppercase, !noStyles && cs.forceUCase);
+}
+
+} // namespace anon
+
-FormCitation::FormCitation(ControlCitation & c)
- : base_class(c, _("Citation"))
+typedef FormController<ControlCitation, FormView<FD_citation> > base_class;
+
+
+FormCitation::FormCitation(Dialog & parent)
+ : base_class(parent, _("Citation"))
{}
void FormCitation::apply()
{
- controller().params().setCmdName("cite");
+ string command = "cite";
+ if (isActive(dialog_->choice_style)) {
+ vector<biblio::CiteStyle> const & styles =
+ ControlCitation::getCiteStyles();
+
+ int const choice =
+ std::max(0, fl_get_choice(dialog_->choice_style) - 1);
+ bool const full =
+ fl_get_button(dialog_->check_full_author_list);
+ bool const force =
+ fl_get_button(dialog_->check_force_uppercase);
+
+ command = biblio::getCiteCommand(styles[choice], full, force);
+ }
+
+ controller().params().setCmdName(command);
controller().params().setContents(getStringFromVector(citekeys));
- string const after = fl_get_input(dialog_->input_after);
+ string const after = getString(dialog_->input_after);
controller().params().setOptions(after);
}
citekeys.clear();
bibkeys.clear();
- FormBase::hide();
+ FormDialogView::hide();
}
void FormCitation::build()
{
- dialog_.reset(build_citation());
+ dialog_.reset(build_citation(this));
+
+ // Manage the ok, apply, restore and cancel/close buttons
+ bcview().setOK(dialog_->button_ok);
+ bcview().setApply(dialog_->button_apply);
+ bcview().setCancel(dialog_->button_close);
+ bcview().setRestore(dialog_->button_restore);
+
+ // disable for read-only documents
+ bcview().addReadOnly(dialog_->button_add);
+ bcview().addReadOnly(dialog_->button_del);
+ bcview().addReadOnly(dialog_->button_up);
+ bcview().addReadOnly(dialog_->button_down);
+ bcview().addReadOnly(dialog_->choice_style);
+ bcview().addReadOnly(dialog_->input_before);
+ bcview().addReadOnly(dialog_->input_after);
+ bcview().addReadOnly(dialog_->check_full_author_list);
+ bcview().addReadOnly(dialog_->check_force_uppercase);
+
+ // trigger an input event for cut&paste with middle mouse button.
+ setPrehandler(dialog_->input_search);
+ setPrehandler(dialog_->input_before);
+ setPrehandler(dialog_->input_after);
fl_set_input_return(dialog_->input_after, FL_RETURN_CHANGED);
fl_set_input_return(dialog_->input_before, FL_RETURN_CHANGED);
+ fl_set_input_return(dialog_->input_search, FL_RETURN_END);
+
+ //set up the tooltip mechanism
+ string str = _("Add the selected entry to the current citation reference.");
+ tooltips().init(dialog_->button_add, str);
+
+ str = _("Delete the selected entry from the current citation reference.");
+ tooltips().init(dialog_->button_del, str);
+
+ str = _("Move the selected entry upwards (in the current list).");
+ tooltips().init(dialog_->button_up, str);
+
+ str = _("Move the selected entry downwards (in the current list).");
+ tooltips().init(dialog_->button_down, str);
+
+ str = _("The entries which will be cited. Select them with the arrow buttons from the right browser window.");
+ tooltips().init(dialog_->browser_cite, str);
+ // Work-around xforms' bug; enable tooltips for browser widgets.
+ setPrehandler(dialog_->browser_cite);
+
+ str = _("All entries in the database you have loaded (via \"Insert->Lists&TOC->BibTex Reference\"). Move the ones you want to cite with the arrow buttons into the left browser window.");
+ tooltips().init(dialog_->browser_bib, str);
+ // Work-around xforms' bug; enable tooltips for browser widgets.
+ setPrehandler(dialog_->browser_bib);
+
+ str = _("Information about the selected entry");
+ tooltips().init(dialog_->browser_info, str);
+ // Work-around xforms' bug; enable tooltips for browser widgets.
+ setPrehandler(dialog_->browser_info);
+
+ str = _("Here you may select how the citation label should look inside the text (Natbib).");
+ tooltips().init(dialog_->choice_style, str);
+
+ str = _("Activate if you want to print all authors in a reference with more than three authors, and not \"<First Author> et al.\" (Natbib).");
+ tooltips().init(dialog_->check_full_author_list, str);
+
+ str = _("Activate if you want to print the first character of the author name as uppercase (\"Van Gogh\", not \"van Gogh\"). Useful at the beginning of sentences (Natbib).");
+ tooltips().init(dialog_->check_force_uppercase, str);
+
+ str = _("Optional text which appears before the citation reference, e.g. \"see <Ref>\"");
+ tooltips().init(dialog_->input_before, str);
+
+ str = _("Optional text which appears after the citation reference, e.g. \"pp. 12\"");
+ tooltips().init(dialog_->input_after, str);
+
+ str = _("Search your database (all fields will be searched).");
+ tooltips().init(dialog_->input_search, str);
+
+ str = _("Activate if you want to have case sensitive search: \"bibtex\" finds \"bibtex\", but not \"BibTeX\".");
+ tooltips().init(dialog_->check_search_case, str);
+
+ str = _("Activate if you want to enter Regular Expressions.");
+ tooltips().init(dialog_->check_search_type, str);
+}
- fl_set_button(dialog_->button_search_case, 0);
- fl_set_button(dialog_->button_search_type, 0);
- // Manage the ok, apply, restore and cancel/close buttons
- bc().setOK(dialog_->button_ok);
- bc().setApply(dialog_->button_apply);
- bc().setCancel(dialog_->button_cancel);
- bc().setRestore(dialog_->button_restore);
+void FormCitation::findBiblio(biblio::Direction const dir)
+{
+ string const str = getString(dialog_->input_search);
+ biblio::InfoMap const & theMap = controller().bibkeysInfo();
+ bool const caseSensitive =
+ fl_get_button(dialog_->check_search_case);
+ biblio::Search const type =
+ fl_get_button(dialog_->check_search_type) ?
+ biblio::REGEX : biblio::SIMPLE;
+
+ vector<string>::const_iterator start = bibkeys.begin();
+ int const sel = fl_get_browser(dialog_->browser_bib);
+ if (sel >= 1 && sel <= int(bibkeys.size()))
+ start += sel - 1;
+
+ // Find the NEXT instance...
+ (dir == biblio::FORWARD) ? ++start : --start;
+
+
+ vector<string>::const_iterator const cit =
+ biblio::searchKeys(theMap, bibkeys, str,
+ start, type, dir, caseSensitive);
- bc().addReadOnly(dialog_->button_add);
- bc().addReadOnly(dialog_->button_del);
- bc().addReadOnly(dialog_->button_up);
- bc().addReadOnly(dialog_->button_down);
- bc().addReadOnly(dialog_->choice_style);
- bc().addReadOnly(dialog_->input_before);
- bc().addReadOnly(dialog_->input_after);
+ if (cit == bibkeys.end())
+ return;
+
+ int const found = int(cit - bibkeys.begin()) + 1;
+ if (found == sel)
+ return;
+ // Update the display
+ int const top = max(found - 5, 1);
+ fl_set_browser_topline(dialog_->browser_bib, top);
+ fl_select_browser_line(dialog_->browser_bib, found);
+ input(dialog_->browser_bib, 0);
}
biblio::InfoMap const & theMap = controller().bibkeysInfo();
+ string topCitekey;
+ if (!citekeys.empty()) topCitekey = citekeys[0];
+
if (ob == dialog_->browser_bib) {
fl_deselect_browser(dialog_->browser_cite);
fl_clear_browser(dialog_->browser_info);
string const tmp = formatted(biblio::getInfo(theMap,
- bibkeys[sel-1]),
- dialog_->browser_info->w-10 );
+ bibkeys[sel - 1]),
+ dialog_->browser_info->w - 10);
fl_add_browser_line(dialog_->browser_info, tmp.c_str());
// Highlight the selected browser_bib key in browser_cite if
// present
vector<string>::const_iterator cit =
- find(citekeys.begin(), citekeys.end(), bibkeys[sel-1]);
+ find(citekeys.begin(), citekeys.end(), bibkeys[sel - 1]);
if (cit != citekeys.end()) {
int const n = int(cit - citekeys.begin());
- fl_select_browser_line(dialog_->browser_cite, n+1);
- fl_set_browser_topline(dialog_->browser_cite, n+1);
+ fl_select_browser_line(dialog_->browser_cite, n + 1);
+ fl_set_browser_topline(dialog_->browser_cite, n + 1);
}
- if (!controller().isReadonly()) {
+ if (!kernel().isBufferReadonly()) {
if (cit != citekeys.end()) {
setBibButtons(OFF);
setCiteButtons(ON);
if (sel < 1 || sel > citekeys.size())
return ButtonPolicy::SMI_NOOP;
- if (!controller().isReadonly()) {
+ if (!kernel().isBufferReadonly()) {
setBibButtons(OFF);
setCiteButtons(ON);
}
// Highlight the selected browser_cite key in browser_bib
vector<string>::const_iterator cit =
- find(bibkeys.begin(), bibkeys.end(), citekeys[sel-1]);
+ find(bibkeys.begin(), bibkeys.end(), citekeys[sel - 1]);
if (cit != bibkeys.end()) {
int const n = int(cit - bibkeys.begin());
- fl_select_browser_line(dialog_->browser_bib, n+1);
- fl_set_browser_topline(dialog_->browser_bib, n+1);
+ fl_select_browser_line(dialog_->browser_bib, n + 1);
+ fl_set_browser_topline(dialog_->browser_bib, n + 1);
// Put into browser_info the additional info associated
// with the selected browser_cite key
fl_clear_browser(dialog_->browser_info);
string const tmp =
- formatted(biblio::getInfo(theMap,
- bibkeys[sel-1]),
- dialog_->browser_info->w-10);
+ formatted(biblio::getInfo(theMap, citekeys[sel - 1]),
+ dialog_->browser_info->w - 10);
fl_add_browser_line(dialog_->browser_info, tmp.c_str());
}
// Add the selected browser_bib key to browser_cite
fl_addto_browser(dialog_->browser_cite,
- bibkeys[sel-1].c_str());
- citekeys.push_back(bibkeys[sel-1]);
+ bibkeys[sel - 1].c_str());
+ citekeys.push_back(bibkeys[sel - 1]);
int const n = int(citekeys.size());
fl_select_browser_line(dialog_->browser_cite, n);
// Remove the selected key from browser_cite
fl_delete_browser_line(dialog_->browser_cite, sel) ;
- citekeys.erase(citekeys.begin() + sel-1);
+ citekeys.erase(citekeys.begin() + sel - 1);
setBibButtons(ON);
setCiteButtons(OFF);
return ButtonPolicy::SMI_NOOP;
// Move the selected key up one line
- vector<string>::iterator it = citekeys.begin() + sel-1;
+ vector<string>::iterator it = citekeys.begin() + sel - 1;
string const tmp = *it;
fl_delete_browser_line(dialog_->browser_cite, sel);
citekeys.erase(it);
- fl_insert_browser_line(dialog_->browser_cite, sel-1, tmp.c_str());
- fl_select_browser_line(dialog_->browser_cite, sel-1);
- citekeys.insert(it-1, tmp);
+ fl_insert_browser_line(dialog_->browser_cite, sel - 1, tmp.c_str());
+ fl_select_browser_line(dialog_->browser_cite, sel - 1);
+ citekeys.insert(it - 1, tmp);
setCiteButtons(ON);
activate = ButtonPolicy::SMI_VALID;
} else if (ob == dialog_->button_down) {
unsigned int const sel = fl_get_browser(dialog_->browser_cite);
- if (sel < 1 || sel > citekeys.size()-1)
+ if (sel < 1 || sel > citekeys.size() - 1)
return ButtonPolicy::SMI_NOOP;
// Move the selected key down one line
- vector<string>::iterator it = citekeys.begin() + sel-1;
+ vector<string>::iterator it = citekeys.begin() + sel - 1;
string const tmp = *it;
fl_delete_browser_line(dialog_->browser_cite, sel);
setCiteButtons(ON);
activate = ButtonPolicy::SMI_VALID;
- } else if (ob == dialog_->button_previous ||
- ob == dialog_->button_next) {
-
- string const str = fl_get_input(dialog_->input_search);
-
- biblio::Direction const dir =
- (ob == dialog_->button_previous) ?
- biblio::BACKWARD : biblio::FORWARD;
-
- biblio::Search const type =
- fl_get_button(dialog_->button_search_type) ?
- biblio::REGEX : biblio::SIMPLE;
-
- vector<string>::const_iterator start = bibkeys.begin();
- int const sel = fl_get_browser(dialog_->browser_bib);
- if (sel >= 1 && sel <= int(bibkeys.size()))
- start += sel-1;
-
- // Find the NEXT instance...
- if (dir == biblio::FORWARD)
- start += 1;
- else
- start -= 1;
-
- bool const caseSensitive =
- fl_get_button(dialog_->button_search_case);
-
- vector<string>::const_iterator const cit =
- biblio::searchKeys(theMap, bibkeys, str,
- start, type, dir, caseSensitive);
-
- if (cit == bibkeys.end())
- return ButtonPolicy::SMI_NOOP;
-
- int const found = int(cit - bibkeys.begin()) + 1;
- if (found == sel)
- return ButtonPolicy::SMI_NOOP;
-
- // Update the display
- int const top = max(found-5, 1);
- fl_set_browser_topline(dialog_->browser_bib, top);
- fl_select_browser_line(dialog_->browser_bib, found);
- input(dialog_->browser_bib, 0);
-
+ } else if (ob == dialog_->button_previous) {
+ findBiblio(biblio::BACKWARD);
+ } else if (ob == dialog_->button_next) {
+ findBiblio(biblio::FORWARD);
+ } else if (ob == dialog_->input_search) {
+ findBiblio(biblio::FORWARD);
} else if (ob == dialog_->choice_style ||
+ ob == dialog_->check_full_author_list ||
+ ob == dialog_->check_force_uppercase ||
ob == dialog_->input_before ||
ob == dialog_->input_after) {
activate = ButtonPolicy::SMI_VALID;
}
+ string currentCitekey;
+ if (!citekeys.empty())
+ currentCitekey = citekeys[0];
+
+ if (topCitekey != currentCitekey) {
+ int choice = std::max(1, fl_get_choice(dialog_->choice_style));
+ fillChoice(dialog_.get(),
+ controller().getCiteStrings(currentCitekey));
+ fl_set_choice(dialog_->choice_style, choice);
+ }
+
return activate;
}
citekeys = getVectorFromString(controller().params().getContents());
updateBrowser(dialog_->browser_cite, citekeys);
+ // Use the first citekey to fill choice_style
+ string key;
+ if (!citekeys.empty())
+ key = citekeys[0];
+
+ fillChoice(dialog_.get(), controller().getCiteStrings(key));
+
+ // Use the citation command to update the GUI
+ updateStyle(dialog_.get(), controller().params().getCmdName());
+
+ bool const natbib = controller().usingNatbib();
+ setEnabled(dialog_->check_full_author_list, natbib);
+ setEnabled(dialog_->check_force_uppercase, natbib);
+ setEnabled(dialog_->choice_style, natbib);
+
// No keys have been selected yet, so...
fl_clear_browser(dialog_->browser_info);
setBibButtons(OFF);
setCiteButtons(OFF);
- int noKeys = int(max(bibkeys.size(), citekeys.size()));
-
- // Place bounds, so that 4 <= noKeys <= 10
- noKeys = max(4, min(10, noKeys));
-
- // Re-size the form to accommodate the new browser size
- int const size = 20 * noKeys;
- bool const bibPresent = (bibkeys.size() > 0);
- setSize(size, bibPresent);
-
+ // Natbib can have comments before and after the citation.
+ // This is not yet supported. After only.
fl_set_input(dialog_->input_after,
controller().params().getOptions().c_str());
+
+ fl_set_input(dialog_->input_before, _("Not yet supported"));
+ setEnabled(dialog_->input_before, false);
}
void FormCitation::updateBrowser(FL_OBJECT * browser,
vector<string> const & keys) const
{
+ // Check whether the current contents of the browser will be
+ // changed by loading the contents of the vec...
+ vector<string> browser_keys = getVector(browser);
+
+ if (browser_keys == keys) {
+ fl_deselect_browser(browser);
+ fl_set_browser_topline(browser, 1);
+ return;
+ }
+
+ // They will be changed. Proceed.
fl_clear_browser(browser);
for (vector<string>::const_iterator it = keys.begin();
- it < keys.end(); ++it) {
- string key = frontStrip(strip(*it));
+ it != keys.end(); ++it) {
+ string key = trim(*it);
if (!key.empty())
fl_add_browser_line(browser, key.c_str());
}
setEnabled(dialog_->button_up, activate_up);
setEnabled(dialog_->button_down, activate_down);
}
-
-
-void FormCitation::setSize(int hbrsr, bool bibPresent) const
-{
- bool const natbib = false; // will eventually be input
- hbrsr = max(hbrsr, 175); // limit max size of cite/bib brsrs
-
- // dh1, dh2, dh3 are the vertical separation between elements.
- // These can be specified because the browser height is fixed
- // so they are not changed by dynamic resizing
- static int const dh1 = 30; // top of form to top of cite/bib brsrs;
- // bottom of cite/bib brsrs to top of info;
- // bottom of info to top search frame;
- // bottom of search frame to top next elemnt;
- // bottom of style to top input_before;
- // bottom of text to top ok/cancel buttons.
- static int const dh2 = 10; // bottom of input_before to top input_after;
- // bottom of ok/cancel buttons to bottom form
- static int const dh3 = 5; // spacing between add/delete/... buttons.
-
- int const wbrsr = dialog_->browser_cite->w;
- static int const hinfo = dialog_->browser_info->h;
- static int const hframe = dialog_->frame_search->h;
- static int const hstyle = dialog_->choice_style->h;
- static int const htext = dialog_->input_after->h;
- static int const hok = dialog_->button_ok->h;
-
- int hform = dh1 + hbrsr + dh1 + hframe + dh1;
- if (bibPresent) hform += hinfo + dh1;
- if (natbib) hform += hstyle + dh1 + htext + dh2;
- hform += htext + dh1 + hok + dh2;
-
- if (hform != minh_) {
- minh_ = hform;
- fl_set_form_size(dialog_->form, minw_, minh_);
- } else
- return;
-
- int x = 0;
- int y = 0;
- fl_set_object_geometry(dialog_->box, x, y, minw_, minh_);
-
- x = dialog_->browser_cite->x;
- y += dh1;
- fl_set_object_geometry(dialog_->browser_cite, x, y, wbrsr, hbrsr);
- x = dialog_->browser_bib->x;
- fl_set_object_geometry(dialog_->browser_bib, x, y, wbrsr, hbrsr);
-
- x = dialog_->button_add->x;
- fl_set_object_position(dialog_->button_add, x, y);
- y += dh3 + dialog_->button_add->h;
- fl_set_object_position(dialog_->button_del, x, y);
- y += dh3 + dialog_->button_del->h;
- fl_set_object_position(dialog_->button_up, x, y);
- y += dh3 + dialog_->button_up->h;
- fl_set_object_position(dialog_->button_down, x, y);
-
- y = dh1 + hbrsr + dh1; // in position for next element
-
- if (bibPresent) {
- x = dialog_->browser_info->x;
- fl_set_object_position(dialog_->browser_info, x, y);
- fl_show_object(dialog_->browser_info);
- y += hinfo + dh1;
- } else
- fl_hide_object(dialog_->browser_info);
-
- x = dialog_->frame_search->x;
- // ??? The frame height seems to be reduced. Use geometry to enforce it.
- fl_set_object_geometry(dialog_->frame_search, x, y,
- dialog_->frame_search->w, hframe);
- //fl_set_object_position(dialog_->frame_search, x, y);
-
- x = dialog_->input_search->x;
- y += 15;
- fl_set_object_position(dialog_->input_search, x, y);
-
- x = dialog_->button_previous->x;
- y += dialog_->input_search->h + 5;
- fl_set_object_position(dialog_->button_previous, x, y);
-
- x = dialog_->button_next->x;
- y += dialog_->button_previous->h + 5;
- fl_set_object_position(dialog_->button_next, x, y);
-
- x = dialog_->button_search_type->x;
- y = dialog_->button_previous->y;
- fl_set_object_position(dialog_->button_search_type, x, y);
-
- x = dialog_->button_search_case->x;
- y = dialog_->button_next->y;
- fl_set_object_position(dialog_->button_search_case, x, y);
-
- y = dialog_->frame_search->y + hframe + dh1;
-
- if (natbib) {
- x = dialog_->choice_style->x;
- fl_set_object_position(dialog_->choice_style, x, y);
- fl_show_object(dialog_->choice_style);
- x = dialog_->input_before->x;
- y += hstyle + dh1;
- fl_set_object_position(dialog_->input_before, x, y);
- fl_show_object(dialog_->input_before);
- y += htext + dh2;
- } else {
- fl_hide_object(dialog_->choice_style);
- fl_hide_object(dialog_->input_before);
- }
-
- x = dialog_->input_after->x;
- fl_set_object_position(dialog_->input_after, x, y);
-
- y += htext + dh1;
- x = dialog_->button_restore->x;
- fl_set_object_position(dialog_->button_restore, x, y);
- x = dialog_->button_ok->x;
- fl_set_object_position(dialog_->button_ok, x, y);
- x = dialog_->button_apply->x;
- fl_set_object_position(dialog_->button_apply, x, y);
- x = dialog_->button_cancel->x;
- fl_set_object_position(dialog_->button_cancel, x, y);
-}
projects / lyx.git / blobdiff