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