← Back to branch summary

~ubuntu-branches/ubuntu/saucy/monodevelop/saucy-proposed

« back to all changes in this revision

Viewing changes to external/mono-tools/gendarme/rules/Gendarme.Rules.Performance/UseStringEmptyRule.cs

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2012-05-27 18:08:20 UTC
  • mfrom: (19.1.8 experimental)
  • Revision ID: package-import@ubuntu.com-20120527180820-fydl21qnbnfr8w2t
Tags: 3.0.2+dfsg-3
* [fcecfe7] Fix monodevelop-core-addins.pc.in to point to actual 
  installed location of assemblies.
* [26e1a07] DebSrc 3.0 does not support Quilt's -p parameter, so 
  manually adjust the path in the patch file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/mono-tools/gendarme/rules/Gendarme.Rules.Performance/UseStringEmptyRule.cs
 
1
//
 
2
// Gendarme.Rules.Performance.UseStringEmpty
 
3
//
 
4
// Authors:
 
5
//      Sebastien Pouliot <sebastien@ximian.com>
 
6
//
 
7
// Copyright (C) 2006-2008 Novell, Inc (http://www.novell.com)
 
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
 
 
31
using Mono.Cecil;
 
32
using Mono.Cecil.Cil;
 
33
 
 
34
using Gendarme.Framework;
 
35
using Gendarme.Framework.Engines;
 
36
using Gendarme.Framework.Helpers;
 
37
 
 
38
namespace Gendarme.Rules.Performance {
 
39
 
 
40
        /// <summary>
 
41
        /// This rule checks for methods that are using the literal <c>""</c> instead of the
 
42
        /// <c>String.Empty</c> field. You'll get slighly better performance by using 
 
43
        /// <c>String.Empty</c>. Note that in some cases, e.g. in a <c>switch/case</c> statement,
 
44
        /// you cannot use a field, so <c>""</c> must be used instead of <c>String.Empty</c>.
 
45
        /// </summary>
 
46
        /// <example>
 
47
        /// Bad example:
 
48
        /// <code>
 
49
        /// string s = "";
 
50
        /// </code>
 
51
        /// </example>
 
52
        /// <example>
 
53
        /// Good example:
 
54
        /// <code>
 
55
        /// string s = String.Empty;
 
56
        /// </code>
 
57
        /// </example>
 
58
 
 
59
        [Problem ("The method uses literal \"\" instead of String.Empty.")]
 
60
        [Solution ("Replace the empty string literal with String.Empty.")]
 
61
        [EngineDependency (typeof (OpCodeEngine))]
 
62
        public class UseStringEmptyRule : Rule, IMethodRule {
 
63
 
 
64
                public RuleResult CheckMethod (MethodDefinition method)
 
65
                {
 
66
                        // rule apply only if the method has a body (e.g. p/invokes, icalls don't)
 
67
                        if (!method.HasBody)
 
68
                                return RuleResult.DoesNotApply;
 
69
 
 
70
                        // check if the method loads some string (Ldstr)
 
71
                        if (!OpCodeEngine.GetBitmask (method).Get (Code.Ldstr))
 
72
                                return RuleResult.DoesNotApply;
 
73
 
 
74
                        // *** ok, the rule applies! ***
 
75
 
 
76
                        // look for string references
 
77
                        foreach (Instruction ins in method.Body.Instructions) {
 
78
                                switch (ins.OpCode.OperandType) {
 
79
                                case OperandType.InlineString:
 
80
                                        string s = (ins.Operand as string);
 
81
                                        if (s.Length == 0)
 
82
                                                Runner.Report (method, ins, Severity.Medium, Confidence.High);
 
83
                                        break;
 
84
                                }
 
85
                        }
 
86
                        return Runner.CurrentRuleResult;
 
87
                }
 
88
        }
 
89
}