mcs/class/Microsoft.Build.Utilities/Microsoft.Build.Utilities/Task.cs

   1 //
   2 // Task.cs: Represents a task.
   3 //
   4 // Author:
   5 //   Marek Sieradzki (marek.sieradzki@gmail.com)
   6 //
   7 // (C) 2005 Marek Sieradzki
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27
  28
  29 using System;
  30 using System.Resources;
  31 using Microsoft.Build.Framework;
  32
  33 namespace Microsoft.Build.Utilities
  34 {
  35         public abstract class Task : ITask
  36         {
  37                 IBuildEngine            buildEngine;
  38                 string                  helpKeywordPrefix;
  39                 ITaskHost               hostObject;
  40                 TaskLoggingHelper       log;
  41                 ResourceManager         taskResources;
  42
  43                 protected Task()
  44                         : this (null, null)
  45                 {
  46                 }
  47
  48                 protected Task(ResourceManager taskResources)
  49                         : this (taskResources, null)
  50                 {
  51                 }
  52
  53                 protected Task(ResourceManager taskResources,
  54                                string helpKeywordPrefix)
  55                 {
  56                         this.taskResources = taskResources;
  57                         this.helpKeywordPrefix = helpKeywordPrefix;
  58                 }
  59
  60                 public abstract bool Execute();
  61
  62                 public IBuildEngine BuildEngine {
  63                         get {
  64                                 return buildEngine;
  65                         }
  66                         set {
  67                                 buildEngine = value;
  68                                 log = new TaskLoggingHelper (this);
  69                         }
  70                 }
  71
  72                 public IBuildEngine2 BuildEngine2 {
  73                         get { return buildEngine as IBuildEngine2; }
  74                 }
  75
  76                 protected string HelpKeywordPrefix {
  77                         get {
  78                                 return helpKeywordPrefix;
  79                         }
  80                         set {
  81                                 helpKeywordPrefix = value;
  82                         }
  83                 }
  84
  85                 public ITaskHost HostObject {
  86                         get {
  87                                 return hostObject;
  88                         }
  89                         set {
  90                                 hostObject = value;
  91                         }
  92                 }
  93
  94                 public TaskLoggingHelper Log {
  95                         get {
  96                                 return log;
  97                         }
  98                 }
  99
 100                 protected ResourceManager TaskResources {
 101                         get {
 102                                 return taskResources;
 103                         }
 104                         set {
 105                                 taskResources = value;
 106                         }
 107                 }
 108         }
 109 }
 110