Mercurial > octave
view libgui/src/welcome-wizard.cc @ 27918:b442ec6dda5c
use centralized file for copyright info for individual contributors
* COPYRIGHT.md: New file.
* In most other files, use "Copyright (C) YYYY-YYYY The Octave Project
Developers" instead of tracking individual names in separate source
files. The motivation is to reduce the effort required to update the
notices each year.
Until now, the Octave source files contained copyright notices that
list individual contributors. I adopted these file-scope copyright
notices because that is what everyone was doing 30 years ago in the
days before distributed version control systems. But now, with many
contributors and modern version control systems, having these
file-scope copyright notices causes trouble when we update copyright
years or refactor code.
Over time, the file-scope copyright notices may become outdated as new
contributions are made or code is moved from one file to
another. Sometimes people contribute significant patches but do not
add a line claiming copyright. Other times, people add a copyright
notice for their contribution but then a later refactoring moves part
or all of their contribution to another file and the notice is not
moved with the code. As a practical matter, moving such notices is
difficult -- determining what parts are due to a particular
contributor requires a time-consuming search through the project
history. Even managing the yearly update of copyright years is
problematic. We have some contributors who are no longer
living. Should we update the copyright dates for their contributions
when we release new versions? Probably not, but we do still want to
claim copyright for the project as a whole.
To minimize the difficulty of maintaining the copyright notices, I
would like to change Octave's sources to use what is described here:
https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html
in the section "Maintaining centralized copyright notices":
The centralized notice approach consolidates all copyright
notices in a single location, usually a top-level file.
This file should contain all of the copyright notices
provided project contributors, unless the contribution was
clearly insignificant. It may also credit -- without a copyright
notice -- anyone who helped with the project but did not
contribute code or other copyrighted material.
This approach captures less information about contributions
within individual files, recognizing that the DVCS is better
equipped to record those details. As we mentioned before, it
does have one disadvantage as compared to the file-scope
approach: if a single file is separated from the distribution,
the recipient won't see the contributors' copyright notices.
But this can be easily remedied by including a single
copyright notice in each file's header, pointing to the
top-level file:
Copyright YYYY-YYYY The Octave Project Developers
See the COPYRIGHT file at the top-level directory
of this distribution or at https://octave.org/COPYRIGHT.html.
followed by the usual GPL copyright statement.
For more background, see the discussion here:
https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html
Most files in the following directories have been skipped intentinally
in this changeset:
doc
libgui/qterminal
liboctave/external
m4
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 15:38:17 -0500 |
parents | cca325162ed7 |
children | 1891570abac8 |
line wrap: on
line source
/* Copyright (C) 2011-2019 The Octave Project Developers See the file COPYRIGHT.md in the top-level directory of this distribution or <https://octave.org/COPYRIGHT.html/>. This file is part of Octave. Octave is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <https://www.gnu.org/licenses/>. */ #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include <QApplication> #include <QDesktopWidget> #include <QHBoxLayout> #include <QPushButton> #include <QVBoxLayout> #if defined (OCTAVE_USE_WINDOWS_API) #define WIN32_LEAN_AND_MEAN #include <windows.h> #endif #include "gui-preferences-nr.h" #include "octave-qobject.h" #include "welcome-wizard.h" namespace octave { static QLabel * make_octave_logo (QWidget *p = nullptr, int height = 100) { QLabel *logo = new QLabel (p); QPixmap logo_pixmap (":/actions/icons/logo.png"); logo->setPixmap (logo_pixmap.scaledToHeight (height)); return logo; }; welcome_wizard::welcome_wizard (base_qobject& oct_qobj, QWidget *p) : QDialog (p), m_octave_qobj (oct_qobj), m_page_ctor_list (), m_page_list_iterator (), m_current_page (initial_page::create (oct_qobj, this)), m_allow_web_connect_state (false), m_max_height (0), m_max_width (0) { m_page_ctor_list.push_back (initial_page::create); m_page_ctor_list.push_back (setup_community_news::create); m_page_ctor_list.push_back (final_page::create); m_page_list_iterator = m_page_ctor_list.begin (); setWindowTitle (tr ("Welcome to GNU Octave")); setEnabled (true); setSizePolicy (QSizePolicy::MinimumExpanding, QSizePolicy::MinimumExpanding); // Create all pages for pre-setting the minimal required size for all pages show_page (); adjust_size (); next_page (); adjust_size (); next_page (); adjust_size (); // now go back to the first page previous_page (); previous_page (); // Set the size determined above resize (m_max_width, m_max_height); #if defined (OCTAVE_USE_WINDOWS_API) // HACK to forceshow of dialog if started minimized ShowWindow (reinterpret_cast<HWND> (winId ()), SW_SHOWNORMAL); #endif } void welcome_wizard::adjust_size (void) { // Get adjusted size for the current page adjustSize (); QSize sz = size (); // Update the max. size of the three pages if required if (sz.height () > m_max_height) m_max_height = sz.height (); if (sz.width () > m_max_width) m_max_width = sz.width (); } void welcome_wizard::handle_web_connect_option (int state) { m_allow_web_connect_state = state == Qt::Checked; } void welcome_wizard::show_page (void) { delete m_current_page; delete layout (); m_current_page = (*m_page_list_iterator) (m_octave_qobj, this); QVBoxLayout *new_layout = new QVBoxLayout (); setLayout (new_layout); new_layout->addWidget (m_current_page); } void welcome_wizard::previous_page (void) { --m_page_list_iterator; show_page (); } void welcome_wizard::next_page (void) { ++m_page_list_iterator; show_page (); } void welcome_wizard::accept (void) { // Create default settings file. resource_manager& rmgr = m_octave_qobj.get_resource_manager (); rmgr.reload_settings (); gui_settings *settings = rmgr.get_settings (); if (settings) { settings->setValue (nr_allow_connection.key, m_allow_web_connect_state); settings->sync (); } QDialog::accept (); } initial_page::initial_page (base_qobject& oct_qobj, welcome_wizard *wizard) : QWidget (wizard), m_title (new QLabel (tr ("Welcome to Octave!"), this)), m_message (new QLabel (this)), m_logo (make_octave_logo (this)), m_next (new QPushButton (tr ("Next"), this)), m_cancel (new QPushButton (tr ("Cancel"), this)) { QFont ft; ft.setPointSize (20); m_title->setFont (ft); resource_manager& rmgr = oct_qobj.get_resource_manager (); m_message->setText (tr ("<html><body>\n" "<p>You seem to be using the Octave graphical interface for the first time on this computer.\n" "Click 'Next' to create a configuration file and launch Octave.</p>\n" "<p>The configuration file is stored in<br>%1.</p>\n" "</body></html>"). arg (rmgr.get_settings_file ())); m_message->setWordWrap (true); m_message->setMinimumWidth (400); QVBoxLayout *message_layout = new QVBoxLayout; message_layout->addWidget (m_title); message_layout->addWidget (m_message); QHBoxLayout *message_and_logo = new QHBoxLayout; message_and_logo->addLayout (message_layout); message_and_logo->addStretch (10); message_and_logo->addWidget (m_logo, 0, Qt::AlignTop); QHBoxLayout *button_bar = new QHBoxLayout; button_bar->addStretch (10); button_bar->addWidget (m_next); button_bar->addWidget (m_cancel); QVBoxLayout *page_layout = new QVBoxLayout (this); setLayout (page_layout); page_layout->addLayout (message_and_logo); page_layout->addStretch (10); page_layout->addSpacing (20); page_layout->addLayout (button_bar); setSizePolicy (QSizePolicy::MinimumExpanding, QSizePolicy::MinimumExpanding); m_next->setDefault (true); m_next->setFocus (); connect (m_next, SIGNAL (clicked ()), wizard, SLOT (next_page ())); connect (m_cancel, SIGNAL (clicked ()), wizard, SLOT (reject ())); } setup_community_news::setup_community_news (base_qobject&, welcome_wizard *wizard) : QWidget (wizard), m_title (new QLabel (tr ("Community News"), this)), m_message (new QLabel (this)), m_checkbox (new QCheckBox (this)), m_checkbox_message (new QLabel (this)), m_logo (make_octave_logo (this)), m_previous (new QPushButton (tr ("Previous"), this)), m_next (new QPushButton (tr ("Next"), this)), m_cancel (new QPushButton (tr ("Cancel"), this)) { QFont ft; ft.setPointSize (20); m_title->setFont (ft); m_message->setText (tr ("<html><body>\n" "<p>When Octave starts, it will optionally check the Octave web site for current news and information about the Octave community.\n" "The check will happen at most once each day and news will only be displayed if there is something new since the last time you viewed the news.</p>\n" "<p>You may also view the news by selecting the \"Community News\" item in the \"Help\" menu, or by visiting\n" "<a href=\"https://octave.org/community-news.html\">https://octave.org/community-news.html</a>.</p>\n" "</body></html>")); m_message->setWordWrap (true); m_message->setMinimumWidth (400); m_message->setOpenExternalLinks (true); QVBoxLayout *message_layout = new QVBoxLayout; message_layout->addWidget (m_title); message_layout->addWidget (m_message); QHBoxLayout *message_and_logo = new QHBoxLayout; message_and_logo->addLayout (message_layout); message_and_logo->addStretch (10); message_and_logo->addWidget (m_logo, 0, Qt::AlignTop); QHBoxLayout *checkbox_layout = new QHBoxLayout; bool allow_connection = nr_allow_connection.def.toBool (); if (allow_connection) m_checkbox->setCheckState (Qt::Checked); else m_checkbox->setCheckState (Qt::Unchecked); m_checkbox_message->setText (tr ("<html><head>\n" "<style>\n" "a:link { text-decoration: underline; color: #0000ff; }\n" "</style>\n" "</head><body>\n" "<p>Allow Octave to connect to the Octave web site when it starts to display current news and information about the Octave community.</p>\n" "</body></html>")); m_checkbox_message->setWordWrap (true); m_checkbox_message->setOpenExternalLinks (true); m_checkbox_message->setMinimumWidth (500); checkbox_layout->addWidget (m_checkbox, 0, Qt::AlignTop); checkbox_layout->addSpacing (20); checkbox_layout->addWidget (m_checkbox_message, 0, Qt::AlignTop); checkbox_layout->addStretch (10); QVBoxLayout *message_logo_and_checkbox = new QVBoxLayout; message_logo_and_checkbox->addLayout (message_and_logo); message_logo_and_checkbox->addSpacing (20); message_logo_and_checkbox->addLayout (checkbox_layout); QHBoxLayout *button_bar = new QHBoxLayout; button_bar->addStretch (10); button_bar->addWidget (m_previous); button_bar->addWidget (m_next); button_bar->addWidget (m_cancel); QVBoxLayout *page_layout = new QVBoxLayout (this); setLayout (page_layout); page_layout->addLayout (message_logo_and_checkbox); page_layout->addStretch (10); page_layout->addSpacing (20); page_layout->addLayout (button_bar); setSizePolicy (QSizePolicy::MinimumExpanding, QSizePolicy::MinimumExpanding); m_next->setDefault (true); m_next->setFocus (); connect (m_checkbox, SIGNAL (stateChanged (int)), wizard, SLOT (handle_web_connect_option (int))); connect (m_previous, SIGNAL (clicked ()), wizard, SLOT (previous_page ())); connect (m_next, SIGNAL (clicked ()), wizard, SLOT (next_page ())); connect (m_cancel, SIGNAL (clicked ()), wizard, SLOT (reject ())); } final_page::final_page (base_qobject&, welcome_wizard *wizard) : QWidget (wizard), m_title (new QLabel (tr ("Enjoy!"), this)), m_message (new QLabel (this)), m_logo (make_octave_logo (this)), m_links (new QLabel (this)), m_previous (new QPushButton (tr ("Previous"), this)), m_finish (new QPushButton (tr ("Finish"), this)), m_cancel (new QPushButton (tr ("Cancel"), this)) { QFont ft; ft.setPointSize (20); m_title->setFont (ft); m_message->setText (tr ("<html><body>\n" "<p>We hope you find Octave to be a useful tool.</p>\n" "<p>If you encounter problems, there are a number of ways to get help, including commercial support options, a mailing list, a wiki, and other community-based support channels.\n" "You can find more information about each of these by visiting <a href=\"https://octave.org/support.html\">https://octave.org/support.html</a> (opens in external browser).</p>\n" "</body></html>")); m_message->setWordWrap (true); m_message->setMinimumWidth (400); m_message->setOpenExternalLinks (true); QVBoxLayout *message_layout = new QVBoxLayout; message_layout->addWidget (m_title); message_layout->addWidget (m_message); QHBoxLayout *message_and_logo = new QHBoxLayout; message_and_logo->addLayout (message_layout); message_and_logo->addStretch (10); message_and_logo->addWidget (m_logo, 0, Qt::AlignTop); m_links->setText (tr ("<html><head>\n" "<style>\n" "a:link { text-decoration: underline; color: #0000ff; }\n" "</style>\n" "</head><body>\n" "<p>For more information about Octave:</p>\n" "<ul>\n" "<li>Visit <a href=\"https://octave.org\">https://octave.org</a> (opens in external browser)</li>\n" "<li>Get the documentation online as <a href=\"https://www.gnu.org/software/octave/doc/interpreter/index.html\">html</a>- or <a href=\"https://www.gnu.org/software/octave/octave.pdf\">pdf</a>-document (opens in external browser)</li>\n" "<li>Open the documentation browser of the Octave GUI with the help menu</li>\n" "</ul>\n" "</body></html>")); m_links->setWordWrap (true); m_links->setOpenExternalLinks (true); QHBoxLayout *button_bar = new QHBoxLayout; button_bar->addStretch (10); button_bar->addWidget (m_previous); button_bar->addWidget (m_finish); button_bar->addWidget (m_cancel); QVBoxLayout *page_layout = new QVBoxLayout (this); setLayout (page_layout); page_layout->addLayout (message_and_logo); page_layout->addSpacing (20); page_layout->addWidget (m_links); page_layout->addStretch (10); page_layout->addSpacing (20); page_layout->addLayout (button_bar); setSizePolicy (QSizePolicy::MinimumExpanding, QSizePolicy::MinimumExpanding); m_finish->setDefault (true); m_finish->setFocus (); connect (m_previous, SIGNAL (clicked ()), wizard, SLOT (previous_page ())); connect (m_finish, SIGNAL (clicked ()), wizard, SLOT (accept ())); connect (m_cancel, SIGNAL (clicked ()), wizard, SLOT (reject ())); } }