aboutsummaryrefslogtreecommitdiff
path: root/DebugUtils/GTMDebugThreadValidation.h
blob: 0636159cb5b3f804fe53612add4048ad124377e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
//
//  GTMDebugThreadValidation.h
//
//  Copyright 2008 Google Inc.
//
//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
//  use this file except in compliance with the License.  You may obtain a copy
//  of the License at
// 
//  http://www.apache.org/licenses/LICENSE-2.0
// 
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
//  License for the specific language governing permissions and limitations under
//  the License.
//

#if DEBUG
#import "GTMDefines.h"
#import <Foundation/Foundation.h>

// GTMAssertRunningOnMainThread will allow you to verify that you are
// currently running on the main thread. This can be useful for checking
// under DEBUG to make sure that code that requires being run on the main thread
// is doing so. Use the GTMAssertRunningOnMainThread macro, don't use
// the _GTMAssertRunningOnMainThread or _GTMIsRunningOnMainThread
// helper functions.

// On Leopard and above we can just use NSThread functionality.
#if MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4
BOOL _GTMIsRunningOnMainThread(void);
#else  // MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4
#import <Foundation/Foundation.h>
GTM_INLINE BOOL _GTMIsRunningOnMainThread(void) { 
  return [NSThread isMainThread]; 
}
#endif  // MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4

GTM_INLINE void _GTMAssertRunningOnMainThread(const char *func,
                                              const char *file, 
                                              int lineNum) { 
  _GTMDevAssert(_GTMIsRunningOnMainThread(), 
                @"%s not being run on main thread (%s - %d)",
                func, file, lineNum);
}

#define GTMAssertRunningOnMainThread() \
  (_GTMAssertRunningOnMainThread(__func__, __FILE__, __LINE__))

#else // DEBUG

#define GTMAssertRunningOnMainThread() do { } while (0)

#endif // DEBUG