git.sesse.net Git - vlc/blob - modules/gui/qt4/dialogs/messages.cpp

   1 /*****************************************************************************
   2  * Messages.cpp : Information about an item
   3  ****************************************************************************
   4  * Copyright (C) 2006-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Jean-Baptiste Kempf <jb (at) videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23 #ifdef HAVE_CONFIG_H
  24 # include "config.h"
  25 #endif
  26
  27 #include "dialogs/messages.hpp"
  28
  29 #include <QSpinBox>
  30 #include <QLabel>
  31 #include <QTextEdit>
  32 #include <QTextCursor>
  33 #include <QFileDialog>
  34 #include <QTextStream>
  35 #include <QMessageBox>
  36 #include <QTabWidget>
  37 #include <QTreeWidget>
  38 #include <QTreeWidgetItem>
  39 #include <QHeaderView>
  40 #include <QMutex>
  41 #include <QLineEdit>
  42 #include <QPushButton>
  43 #include <QScrollBar>
  44
  45 #include <assert.h>
  46
  47 enum {
  48     MsgEvent_Type = QEvent::User + MsgEventType + 1,
  49 };
  50
  51 class MsgEvent : public QEvent
  52 {
  53 public:
  54     MsgEvent( msg_item_t *msg )
  55         : QEvent( (QEvent::Type)MsgEvent_Type ), msg(msg)
  56     {
  57         msg_Hold( msg );
  58     }
  59     virtual ~MsgEvent()
  60     {
  61         msg_Release( msg );
  62     }
  63
  64     msg_item_t *msg;
  65 };
  66
  67 struct msg_cb_data_t
  68 {
  69     MessagesDialog *self;
  70 };
  71 static void MsgCallback( msg_cb_data_t *, msg_item_t *, unsigned );
  72
  73 MessagesDialog::MessagesDialog( intf_thread_t *_p_intf)
  74                : QVLCFrame( _p_intf )
  75 {
  76     setWindowTitle( qtr( "Messages" ) );
  77     setWindowRole( "vlc-messages" );
  78
  79     /* General widgets */
  80     QGridLayout *mainLayout = new QGridLayout( this );
  81     mainTab = new QTabWidget( this );
  82     mainTab->setTabPosition( QTabWidget::North );
  83
  84
  85     /* Messages */
  86     QWidget     *msgWidget = new QWidget;
  87     QGridLayout *msgLayout = new QGridLayout( msgWidget );
  88
  89     messages = new QTextEdit();
  90     messages->setReadOnly( true );
  91     messages->setGeometry( 0, 0, 440, 600 );
  92     messages->setHorizontalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
  93     messages->setTextInteractionFlags( Qt::TextSelectableByMouse );
  94
  95     msgLayout->addWidget( messages, 0, 0, 1, 0 );
  96     mainTab->addTab( msgWidget, qtr( "Messages" ) );
  97
  98
  99     /* Modules tree */
 100     QWidget     *treeWidget = new QWidget;
 101     QGridLayout *treeLayout = new QGridLayout( treeWidget );
 102
 103     modulesTree = new QTreeWidget();
 104     modulesTree->header()->hide();
 105
 106     treeLayout->addWidget( modulesTree, 0, 0, 1, 0 );
 107     mainTab->addTab( treeWidget, qtr( "Modules tree" ) );
 108
 109
 110     /* Buttons and general layout */
 111     QPushButton *closeButton = new QPushButton( qtr( "&Close" ) );
 112     closeButton->setDefault( true );
 113     clearUpdateButton = new QPushButton( qtr( "C&lear" ) );
 114     saveLogButton = new QPushButton( qtr( "&Save as..." ) );
 115     saveLogButton->setToolTip( qtr( "Saves all the displayed logs to a file" ) );
 116
 117     verbosityBox = new QSpinBox();
 118     verbosityBox->setRange( 0, 2 );
 119     verbosityBox->setValue( var_InheritInteger( p_intf, "verbose" ) );
 120     verbosityBox->setWrapping( true );
 121     verbosityBox->setMaximumWidth( 50 );
 122
 123     verbosityLabel = new QLabel( qtr( "Verbosity Level" ) );
 124
 125     vbobjectsEdit = new QLineEdit();
 126
 127     vbobjectsEdit->setMaximumWidth( 100 );
 128     vbobjectsEdit->setText(config_GetPsz( p_intf, "verbose-objects"));
 129     vbobjectsEdit->setToolTip( "verbose-objects usage: \n"
 130                             "--verbose-objects=+printthatobject,-dontprintthatone\n"
 131                             "(keyword 'all' to applies to all objects)");
 132
 133     vbobjectsLabel =  new QLabel( qtr( "Message filter" ) );
 134
 135     mainLayout->addWidget( mainTab, 0, 0, 1, 0 );
 136     mainLayout->addWidget( verbosityLabel, 1, 0, 1, 1 );
 137     mainLayout->addWidget( verbosityBox, 1, 1 );
 138     mainLayout->addWidget( vbobjectsLabel, 1, 2, 1, 1 );
 139     mainLayout->addWidget( vbobjectsEdit, 1, 3 );
 140     mainLayout->setColumnStretch( 4, 10 );
 141     mainLayout->addWidget( saveLogButton, 1, 5 );
 142     mainLayout->addWidget( clearUpdateButton, 1, 6 );
 143     mainLayout->addWidget( closeButton, 1, 7 );
 144
 145     BUTTONACT( closeButton, hide() );
 146     BUTTONACT( clearUpdateButton, clearOrUpdate() );
 147     BUTTONACT( saveLogButton, save() );
 148     CONNECT( mainTab, currentChanged( int ),
 149              this, updateTab( int ) );
 150     CONNECT(vbobjectsEdit, editingFinished(), this, updateConfig());
 151     CONNECT( verbosityBox, valueChanged( int ),
 152              this, changeVerbosity( int ) );
 153
 154     /* General action */
 155     readSettings( "Messages", QSize( 600, 450 ) );
 156
 157
 158     /* Hook up to LibVLC messaging */
 159     cbData = new msg_cb_data_t;
 160     cbData->self = this;
 161     sub = msg_Subscribe( p_intf->p_libvlc, MsgCallback, cbData );
 162     changeVerbosity( verbosityBox->value() );
 163 }
 164
 165 MessagesDialog::~MessagesDialog()
 166 {
 167     writeSettings( "Messages" );
 168     msg_Unsubscribe( sub );
 169     delete cbData;
 170 };
 171
 172 void MessagesDialog::changeVerbosity( int verbosity )
 173 {
 174     msg_SubscriptionSetVerbosity( sub , verbosity );
 175 }
 176
 177 void MessagesDialog::updateTab( int index )
 178 {
 179     /* Second tab : modules tree */
 180     if( index == 1 )
 181     {
 182         verbosityLabel->hide();
 183         verbosityBox->hide();
 184         vbobjectsLabel->hide();
 185         vbobjectsEdit->hide();
 186         clearUpdateButton->setText( qtr( "&Update" ) );
 187         saveLogButton->hide();
 188         updateTree();
 189     }
 190     /* First tab : messages */
 191     else
 192     {
 193         verbosityLabel->show();
 194         verbosityBox->show();
 195         vbobjectsLabel->show();
 196         vbobjectsEdit->show();
 197         clearUpdateButton->setText( qtr( "&Clear" ) );
 198         saveLogButton->show();
 199     }
 200 }
 201
 202 void MessagesDialog::updateConfig()
 203 {
 204     config_PutPsz(p_intf, "verbose-objects", qtu(vbobjectsEdit->text()));
 205     //vbobjectsEdit->setText("vbEdit changed!");
 206
 207     if( !vbobjectsEdit->text().isEmpty() )
 208     {
 209         /* if user sets filter, go with the idea that user just wants that to be shown,
 210            so disable all by default and enable those that user wants */
 211         msg_DisableObjectPrinting( p_intf, "all");
 212         char * psz_verbose_objects = strdup(qtu(vbobjectsEdit->text()));
 213         char * psz_object, * iter =  psz_verbose_objects;
 214         while( (psz_object = strsep( &iter, "," )) )
 215         {
 216             switch( psz_object[0] )
 217             {
 218                 printf("%s\n", psz_object+1);
 219                 case '+': msg_EnableObjectPrinting(p_intf, psz_object+1); break;
 220                 case '-': msg_DisableObjectPrinting(p_intf, psz_object+1); break;
 221                 /* user can but just 'lua,playlist' on filter */
 222                 default: msg_EnableObjectPrinting(p_intf, psz_object); break;
 223              }
 224         }
 225         free( psz_verbose_objects );
 226     }
 227     else
 228     {
 229         msg_EnableObjectPrinting( p_intf, "all");
 230     }
 231 }
 232
 233 void MessagesDialog::sinkMessage( msg_item_t *item )
 234 {
 235     /* Only scroll if the viewport is at the end.
 236        Don't bug user by auto-changing/loosing viewport on insert(). */
 237     bool b_autoscroll = ( messages->verticalScrollBar()->value()
 238                           + messages->verticalScrollBar()->pageStep()
 239                           >= messages->verticalScrollBar()->maximum() );
 240
 241     /* Copy selected text to the clipboard */
 242     if( messages->textCursor().hasSelection() )
 243         messages->copy();
 244
 245     /* Fix selected text bug */
 246     if( !messages->textCursor().atEnd() ||
 247          messages->textCursor().anchor() != messages->textCursor().position() )
 248          messages->moveCursor( QTextCursor::End );
 249
 250     messages->setFontItalic( true );
 251     messages->setTextColor( "darkBlue" );
 252     messages->insertPlainText( qfu( item->psz_module ) );
 253
 254     switch (item->i_type)
 255     {
 256         case VLC_MSG_INFO:
 257             messages->setTextColor( "blue" );
 258             messages->insertPlainText( " info: " );
 259             break;
 260         case VLC_MSG_ERR:
 261             messages->setTextColor( "red" );
 262             messages->insertPlainText( " error: " );
 263             break;
 264         case VLC_MSG_WARN:
 265             messages->setTextColor( "green" );
 266             messages->insertPlainText( " warning: " );
 267             break;
 268         case VLC_MSG_DBG:
 269         default:
 270             messages->setTextColor( "grey" );
 271             messages->insertPlainText( " debug: " );
 272             break;
 273     }
 274
 275     /* Add message Regular black Font */
 276     messages->setFontItalic( false );
 277     messages->setTextColor( "black" );
 278     messages->insertPlainText( qfu(item->psz_msg) );
 279     messages->insertPlainText( "\n" );
 280     if ( b_autoscroll ) messages->ensureCursorVisible();
 281 }
 282
 283 void MessagesDialog::customEvent( QEvent *event )
 284 {
 285     MsgEvent *msge = static_cast<MsgEvent *>(event);
 286
 287     assert( msge );
 288     sinkMessage( msge->msg );
 289 }
 290
 291 void MessagesDialog::clearOrUpdate()
 292 {
 293     if( mainTab->currentIndex() )
 294         updateTree();
 295     else
 296         clear();
 297 }
 298
 299 void MessagesDialog::clear()
 300 {
 301     messages->clear();
 302 }
 303
 304 bool MessagesDialog::save()
 305 {
 306     QString saveLogFileName = QFileDialog::getSaveFileName(
 307             this, qtr( "Save log file as..." ),
 308             QVLCUserDir( VLC_DOCUMENTS_DIR ),
 309             qtr( "Texts / Logs (*.log *.txt);; All (*.*) ") );
 310
 311     if( !saveLogFileName.isNull() )
 312     {
 313         QFile file( saveLogFileName );
 314         if ( !file.open( QFile::WriteOnly | QFile::Text ) ) {
 315             QMessageBox::warning( this, qtr( "Application" ),
 316                     qtr( "Cannot write to file %1:\n%2." )
 317                     .arg( saveLogFileName )
 318                     .arg( file.errorString() ) );
 319             return false;
 320         }
 321
 322         QTextStream out( &file );
 323         out << messages->toPlainText() << "\n";
 324
 325         return true;
 326     }
 327     return false;
 328 }
 329
 330 void MessagesDialog::buildTree( QTreeWidgetItem *parentItem,
 331                                 vlc_object_t *p_obj )
 332 {
 333     QTreeWidgetItem *item;
 334
 335     if( parentItem )
 336         item = new QTreeWidgetItem( parentItem );
 337     else
 338         item = new QTreeWidgetItem( modulesTree );
 339
 340     char *name = vlc_object_get_name( p_obj );
 341     if( name != NULL )
 342     {
 343         item->setText( 0, qfu( p_obj->psz_object_type ) + " \"" +
 344                        qfu( name ) + "\" (" +
 345                        QString::number((uintptr_t)p_obj) + ")" );
 346         free( name );
 347     }
 348     else
 349         item->setText( 0, qfu( p_obj->psz_object_type ) + " (" +
 350                        QString::number((uintptr_t)p_obj) + ")" );
 351
 352     item->setExpanded( true );
 353
 354     vlc_list_t *l = vlc_list_children( p_obj );
 355     for( int i=0; i < l->i_count; i++ )
 356         buildTree( item, l->p_values[i].p_object );
 357     vlc_list_release( l );
 358 }
 359
 360 void MessagesDialog::updateTree()
 361 {
 362     modulesTree->clear();
 363     buildTree( NULL, VLC_OBJECT( p_intf->p_libvlc ) );
 364 }
 365
 366 static void MsgCallback( msg_cb_data_t *data, msg_item_t *item, unsigned )
 367 {
 368     int canc = vlc_savecancel();
 369
 370     QApplication::postEvent( data->self, new MsgEvent( item ) );
 371
 372     vlc_restorecancel( canc );
 373 }
 374