include/Support/SlowOperationInformer.h

   1 //===- SlowOperationInformer.h - Keep the user informed ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines a simple object which can be used to let the user know what
  11 // is going on when a slow operation is happening, and gives them the ability to
  12 // cancel it.  Potentially slow operations can stack allocate one of these
  13 // objects, and periodically call the "progress" method to update the progress
  14 // bar.  If the operation takes more than 1 second to complete, the progress bar
  15 // is automatically shown and updated.  As such, the slow operation should not
  16 // print stuff to the screen, and should not be confused if an extra line
  17 // appears on the screen (ie, the cursor should be at the start of the line).
  18 //
  19 // If the user presses CTRL-C during the operation, the next invocation of the
  20 // progress method with throw an std::string object indicating that the
  21 // operation was cancelled.  As such, client code must be exception safe around
  22 // the progress method.
  23 //
  24 // Because SlowOperationInformers fiddle around with signals, they cannot be
  25 // nested, and interact poorly with threads.  The SIGALRM handler is set back to
  26 // SIGDFL, but the SIGINT signal handler is restored when the
  27 // SlowOperationInformer is destroyed.
  28 //
  29 //===----------------------------------------------------------------------===//
  30
  31 #ifndef SUPPORT_SLOW_OPERATION_INFORMER_H
  32 #define SUPPORT_SLOW_OPERATION_INFORMER_H
  33
  34 #include <string>
  35
  36 namespace llvm {
  37   class SlowOperationInformer {
  38     std::string OperationName;
  39     unsigned LastPrintAmount;
  40
  41     SlowOperationInformer(const SlowOperationInformer&);   // DO NOT IMPLEMENT
  42     void operator=(const SlowOperationInformer&);          // DO NOT IMPLEMENT
  43   public:
  44     SlowOperationInformer(const std::string &Name);
  45     ~SlowOperationInformer();
  46
  47     /// progress - Clients should periodically call this method when they are in
  48     /// an exception-safe state.  The Amount variable should indicate how far
  49     /// along the operation is, given in 1/10ths of a percent (in other words,
  50     /// Amount should range from 0 to 1000).
  51     void progress(unsigned Amount);
  52   };
  53 } // end namespace llvm
  54
  55 #endif /* SLOW_OPERATION_INFORMER_H */